Run workflow API

The /run-workflow endpoint allows an external system to initiate a workflow, provide input values and receive output values.

Run a workflow

post

Body

workflow related to PbxCallworkflow related to VoIPcube callIdworkflow without scope

instanceIdnumberoptional

Example: 602

triggernumberoptional

Example: 100

inputParametersobject[]optional

pbxCallobjectoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/run-workflow' \
  --header 'Content-Type: workflow related to PbxCall' \
  --data '{
    "instanceId": 602,
    "trigger": 100,
    "inputParameters": [
      {
        "name": "input1",
        "value": "testvalue!"
      }
    ],
    "pbxCall": {
      "hookId": 1234,
      "phoneNumber": "[phone]"
    }
  }'

workflow related to PbxCallworkflow related to VoIPcube callIdworkflow without scope

200

202

200

{
  "workflowsExecuted": 1,
  "workflows": [
    {
      "id": "9f41f83b-83fb-4f4b-ba55-201c3d84f069",
      "name": "Workflow 1",
      "success": true,
      "output": [
        {
          "name": "TicketNumber",
          "type": "String",
          "value": "#1232149239"
        }
      ]
    }
  ]
}

Example response with all workflows succesful