POST
/events/sendSend an event
Sends an event and associates it with a contact or an email address. Supply the required event name and exactly one of contact_id or email; include payload to attach additional key/value data.
- IdempotentThe SDK sends
Idempotency-Key, so a retried request is only applied once.
Event name, one contact identifier, and optional event payload.
eventstringrequired
The name of the event to send.
contact_idstringoptional
The ID of the contact to associate with this event. Exactly one of `contact_id` or `email` must be provided.
emailstringoptional
The email address to associate with this event. Exactly one of `contact_id` or `email` must be provided.
payloadobjectoptional
An optional payload of key/value pairs to include with the event.
202Confirms the event was accepted for processing and returns its name in `event` and the response object type.
objectstringoptional
Type of the response object.
eventstringoptional
The name of the event that was sent.
Error handling
event is required, and you must provide exactly one of contact_id or email. contact_id must use UUID format, email must use email format, and payload can contain additional key/value pairs.