Skip to main content
POST
Report Event

Authorizations

Authorization
string
header
required

Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.

Headers

Thinnest-Workspace
string

Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Body

application/json
to
string
required

The customer's number, with or without the +; spaces are fine. Matched to a contact by its digits; a new number creates a contact.

Example:

"+91 98765 43210"

event
string
required

What happened, as a name. Normalised and echoed back — lower case, anything but letters, digits, ., - and _ becomes a dot, 60 characters at most — so "Order Delivered" is stored as order.delivered. Subscribe to the name that comes back.

Example:

"order.delivered"

data
object

Values to carry into the sequences this starts, for their templates to use — an order number, a courier. At most 20; each name 1–60 characters (a longer one is refused); values are text, numbers or true/false, stored as text and cut at 300 characters. An object or list as a value is refused.

Example:
name
string

The customer's name, if you have it. Used for a contact this call creates, or one with no name yet. Cut at 120 characters.

Maximum string length: 120
Example:

"Priya Nair"

Response

Recorded, and what it did.

ok
boolean
required

The event was recorded.

event
string
required

The normalised name. Set your subscriptions up against this, not what you sent.

contact
string | null
required

The contact the event was recorded against (cust_…), the id Get Contact takes.

started
integer
required

Sequences this event enrolled the contact into.

stopped
integer
required

Sequences it took them out of.

tagged
integer
required

Tags added to or removed from the contact.

matched
boolean
required

Whether anything was subscribed and acted.

note
string

Only when nothing acted: says nothing is subscribed to this event yet.