v1

latestOpenAPI 3.0.02026-07-2612645160.3 KB
Events API

Ingest a custom event

Accepts a customer event (e.g. "purchase", "new_account_created") and stores it for downstream processing. The event is associated with a contact (resolved via aiContactId or phone) on a specific channel (resolved via channelId or channelPhone); a contact is created when none matches. The event is persisted synchronously and the response carries its id; enrichment and automations run in the background. Rate limited to 1000 requests per hour per client.

post/api/v1/events

Headers

x-api-keystring required

API key used to authorize the request

Request body

eventstring required
occurredAtstring date-time
propertiesobject required

Response

Event stored. Returns the persisted event id.

idstring uuid

Example response

{
  "id": "df980fc8-b6db-4820-bf22-2969482d106d"
}