Skip to content

Management API

The Management API provides CRUD operations for configuring your CDP. It is protected by Cognito JWT authentication.

https://your-management-api.amazonaws.com

Include a Cognito JWT bearer token in the Authorization header:

Terminal window
curl -H "Authorization: Bearer YOUR_JWT_TOKEN" \
https://your-management-api.amazonaws.com/sources
GET /sources

Returns all configured event sources with their write keys.

POST /sources
{
"name": "Production App",
"description": "Main web application"
}

A writeKey is automatically generated using SHA-256 hashing.

DELETE /sources/:id
GET /destinations
POST /destinations
{
"name": "Slack Webhook",
"type": "webhook",
"config": {
"url": "https://hooks.slack.com/...",
"secret": "webhook_secret"
}
}

Supported types: webhook, s3-export, or any custom connector ID.

PUT /destinations/:id
{
"name": "Updated Name",
"config": { "url": "https://new-url.com" }
}
DELETE /destinations/:id
GET /segments
POST /segments
{
"name": "Power Users",
"description": "Users with more than 100 events",
"rules": [
{
"field": "event_count",
"operator": "gt",
"value": 100
}
]
}

Rules use a field / operator / value structure. Available operators: eq, neq, gt, gte, lt, lte, contains, not_contains.

PUT /segments/:id
DELETE /segments/:id
GET /segments/:id/members

Returns all user IDs that belong to the segment.

GET /profiles/:userId

Returns the unified profile with merged traits and associated events.

{
"userId": "user_123",
"traits": {
"name": "Jane Doe",
"email": "jane@acme.com",
"plan": "pro"
},
"events": [
{
"type": "track",
"event": "Purchase Completed",
"timestamp": "2025-03-08T12:00:00.000Z",
"properties": { "revenue": 99.99 }
}
]
}