Trigger a chatbot flow (sync)

Starts a chatbot project's flow from an external event and waits for the result.

Requires the flow:trigger scope. Only chatbot projects are accepted: an automation project returns 400 Automation projects must use the automation trigger API, and any other project type returns 400 External API access is not supported for this project type.

The request is checked against the flow's Trigger node: the external trigger must be enabled, a triggerKey you send must match the node's key, and the payload must contain every top-level key of the node's payload schema. A failed check returns 500 with the reasons in error. Send dryRun: true to see the validation result without running the flow.

A chatbot's Trigger node has no editor for the expected payload, so it keeps the default keys event and customerId; send both as top-level fields.

Path ParametersCopy Anchor Link

Header ParametersCopy Anchor Link

Response BodyCopy Anchor Link

curl -X POST "https://example.com/flows/string/trigger" \  -H "Content-Type: application/json" \  -d '{    "triggerKey": "external_event",    "event": "checkout.started",    "customerId": "cus_123",    "cartTotal": 4900  }'

{  "invocationId": "clx9kb0d10007ab12cd34ef11",  "status": "SUCCEEDED",  "result": {    "messages": [      "Hi Ama, you left 2 items in your cart."    ],    "actions": []  }}