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/run-workflow

Body

workflow related to PbxCallworkflow related to VoIPcube callIdworkflow without scope

instanceIdnumber

Example: 602

triggernumber

Example: 100

inputParametersarray of object

pbxCallobject

Response

200202

Example response with all workflows succesful

Body

application/json

workflowsExecutedinteger (int32)

Example: 1

workflowsarray of object

Request

JavaScriptCurlPython

const response = await fetch('/run-workflow', {
    method: 'POST',
    headers: {
      "Content-Type": "workflow related to PbxCall"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200202

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