Skip to content

Events API

POST /ingest/events

Request Body:

{
"event": "purchase",
"customerId": "cust_abc123",
"amount": 4999,
"metadata": {
"orderId": "ord_456",
"items": ["sku_a", "sku_b"]
}
}
FieldTypeRequiredDescription
eventstringYesEvent type
customerIdstringYesCustomer identifier
amountnumberNoValue in cents
metadataobjectNoCustom event data
timestampstringNoISO 8601 (defaults to now)

Response:

{
"success": true,
"data": {
"id": "evt_abc123",
"event": "purchase",
"status": "queued"
}
}
POST /ingest/events/batch

Send up to 100 events in a single request:

{
"events": [
{
"event": "purchase",
"customerId": "cust_abc123",
"amount": 4999
},
{
"event": "review",
"customerId": "cust_abc123",
"metadata": {"productId": "prod_789", "rating": 5}
}
]
}
GET /v1/events

Query Parameters:

ParameterTypeDescription
customerIdstringFilter by customer
eventstringFilter by event type
fromstringStart date (ISO 8601)
tostringEnd date (ISO 8601)