Skip to main content
POST
Record an event, or a batch

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true).

Maximum string length: 255

Body

application/json
email
string<email>
required
name
string
required

Yours to choose. order is counted as revenue; cart.abandoned starts the ready-made basket journey.

Maximum string length: 100
Pattern: ^[A-Za-z0-9 _.:-]+$
Example:

"cart.abandoned"

properties
object | null

Whatever describes it. Available in the e-mails of the automation it starts, as {{ event.… }}.

value
integer | null

In the smallest unit: 1250 is 12.50 €. Requires currency.

Required range: x >= 0
currency
string | null
Required string length: 3
occurred_at
string<date-time> | null

Now, when absent. At most one day ahead.

reference
string | null

Your own identifier — an order number. The same reference twice is recorded once.

Maximum string length: 255

Response

One event whose reference was already known (duplicate), or a batch: data holds one result per row and failed counts the invalid ones.

data
object
failed
integer