Skip to main content
POST
Send a Workflow 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. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.

Example:

"org_3fKq9TzQ1mN8vB2xR7cLpA"

Body

application/json
to
string
required

The contact's phone number, with its country code.

event
string
required

The event's name, as written in the Await block, like payment_received.

Pattern: ^[A-Za-z0-9_.-]{1,64}$
data
object

Anything you want kept with the event (up to 4,000 characters).

Response

Recorded. waiting is how many of the contact's runs were waiting on an event and will be looked at now.

recorded
boolean
required
event
string
required
waiting
integer
required

The contact's runs waiting on an event, looked at now.