v1

latestOpenAPI 3.1.02026-07-22115189303.8 KB

Workflow Triggers

Create workflow trigger

Create a new trigger for a workflow. Triggers define when the workflow should automatically execute.

Trigger types:

inbound_message: Workflow starts when WhatsApp messages arrive at specified phone number (requires phone_number_id)
api_call: Workflow starts only via POST /workflows/{id}/executions (no phone_number_id needed)

After creating a trigger:

For inbound_message: Messages to the phone_number_id will start workflow executions
For api_call: Workflow can only be started via API endpoint

Note: A workflow can have multiple triggers (e.g., multiple phone numbers, or both inbound_message and api_call).

post/workflows/{workflow_id}/triggers

{
  "trigger": {
    "phone_number_id": "123456789012345",
    "event_name": "conversation.csat_scored",
    "property_key": "score"
  }
}

Trigger created successfully

{
  "data": {
    "triggerable": {
      "event_name": "conversation.csat_scored",
      "property_key": "score"
    }
  }
}