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

instanceIdnumberOptionalExample: 602

triggernumberOptionalExample: 100

Responses

200

Example response with all workflows succesful

application/json

workflowsExecutedinteger · int32OptionalExample: 1

202

Example response with a workflow error

application/json

post/run-workflow

HTTPcURLJavaScriptPython

POST /run-workflow HTTP/1.1
Content-Type: workflow related to PbxCall
Accept: */*
Content-Length: 146

{
  "instanceId": 602,
  "trigger": 100,
  "inputParameters": [
    {
      "name": "input1",
      "value": "testvalue!"
    }
  ],
  "pbxCall": {
    "hookId": 1234,
    "phoneNumber": "[phone]"
  }
}

workflow related to PbxCallworkflow related to VoIPcube callIdworkflow without scope

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