Skip to main content
POST
Records an event log for a contact. The eventName must match an existing event definition; supplied eventProperties are validated and coerced against the declared property schema. Either email or contactId is required to identify the contact.
Triggering an event also evaluates any active workflow automations whose entry criteria match this event name. The workflow evaluation is fire-and-forget — it never blocks the API response.

Authorizations

string | header
required
Project API key header of the form Bearer AS_<key>.

Body

string
required
Name of an existing event definition for this project.Example: "order_completed"
You must provide either email or contactId to identify the contact. Providing both is allowed - contactId takes precedence.
string
Email address of the contact this event belongs to.Example: "[email protected]"
string
ID of the contact this event belongs to.Example: "60d5ec49f1b2c72d9c8b8888"
object
Key/value map of property values. Each key must match a propertyName declared on the event definition; values are coerced to the declared type (string, number, date, or boolean). Unknown properties are rejected.Example: { "order_total": 129.99, "currency": "USD" }

Response

Event recorded (201)
boolean
Example: true
object
The recorded event log

Error Responses

object
Returned when neither email nor contactId is provided.
object
object
object
Returned when eventProperties contains a key not declared on the event definition.
object
Returned when a property value cannot be coerced to its declared type.