Events
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
Headers
API key used to authorize the request
Body
application/json
Event payload. contact requires at least one of aiContactId or phone; channel requires at least one of channelId or channelPhone.
Required string length:
1 - 100Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$Response
Event stored. Returns the persisted event id.
Example:
"df980fc8-b6db-4820-bf22-2969482d106d"