Skip to main content
POST
/
workflows
/
{workflowId}
/
trigger
cURL
curl --request POST \
  --url https://workflows.pingmee.co.il/workflows/{workflowId}/trigger \
  --header 'Content-Type: application/json' \
  --header 'Cookie: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phoneNumberId": "<string>",
  "customerPhoneNumberId": "<string>",
  "startFromNodeId": "<string>",
  "triggerData": {}
}
'
{
  "ok": true
}

Authorizations

​
Cookie
string
header
required
​
x-api-key
string
header
required

Path Parameters

​
workflowId
string
required

Workflow identifier.

Body

application/json

Conversation, optional node to start the workflow from, and optional JSON payload for the trigger.

​
phoneNumberId
string
required

Business phone number identifier.

​
customerPhoneNumberId
string
required

Customer phone number identifier.

​
startFromNodeId
string

Optional workflow node identifier to start execution from.

​
triggerData
object

Optional JSON object passed to the workflow when it is triggered.

Response

Workflow triggered successfully

​
ok
boolean
required
Example:

true