Skip to main content
POST
Track event
Emit a single event for a user. The endpoint accepts both the 10 canonical lifecycle event names and any custom name you choose.

Request

Body

string
required
External user ID. Should match the ID used in Upsert user. If the user hasn’t been identified yet, the event is buffered and attached when they’re first seen.
string
required
Event name. One of the canonical 10 or any custom string (snake_case recommended).
object
JSON-serialisable property bag. Optional — defaults to {}.

Response

boolean
Always true on success. The event is enqueued and processed asynchronously.

Examples

Common errors

Missing or malformed Authorization header.
API key valid but not authorised for this resource.
Body failed schema validation; errors[0].field indicates the offending field.
Wait Retry-After seconds.
Retry — the Idempotency-Key prevents duplicates.