Sign in
Workflows

Start an API-triggered workflow

Starts a run of an active workflow whose trigger type is api_call. Pass exactly one target: conversationId (a conversation on the workflow's account), contactId (resolved to that contact's conversation on the workflow's account), or to (WhatsApp workflows only: a phone number, whose conversation is found or created). variables are merged over the standard run variables, so each key is available as {{key}}.

post/v1/workflows/{workflowId}/trigger

Path parameters

workflowIdstring required

Request body

conversationIdstring

A conversation on the workflow's account

contactIdstring

A contact with a conversation on the workflow's account

tostring

Recipient phone in E.164 (WhatsApp workflows only)

variablesobject

Seed variables, merged over the standard run variables

Response

Run started

executionIdstring required

Changes

Changed in 1 of the 69 revisions of this API.1