Events API
Send contact events to drive segmentation and automation triggers.
Send contact events to drive segmentation and automation triggers.
Endpoint
| Method | Path |
|---|---|
POST | /api/v1/events |
Request body
{
"email": "john@example.com",
"eventName": "purchase_completed",
"eventProperties": {
"orderId": "ORD-123",
"amount": 99.99
},
"createContactIfNotExists": true
}
Fields:
email(required)eventName(required)eventProperties(optional object)createContactIfNotExists(optional boolean, defaultfalse)
eventName constraints:
- must start with a letter
- allowed chars: letters, numbers,
_,- - max length: 100
Success response
{
"data": {
"eventId": "evt_m6e...",
"contactId": "j57...",
"eventName": "purchase_completed",
"triggeredAutomations": 1,
"contactCreated": true
}
}
Common errors
404 contact_not_foundwhen contact does not exist andcreateContactIfNotExistsis not enabled400 invalid_event_namefor invalid event naming400 invalid_jsonfor malformed payloads