Execute workflow

POST

/workflows/{id}/run

Manually trigger a workflow execution

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Path Params

Body Params application/json

Examples

Responses

🟢200

application/json

Workflow execution result

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/workflows//run' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "conversation": {
        "id": "string",
        "phone": "string",
        "status": "string",
        "tags": [
            "string"
        ],
        "customerId": "string",
        "customerName": "string"
    },
    "message": {
        "id": "string",
        "text": "string",
        "fromMe": true,
        "timestamp": "string",
        "mediaType": "string",
        "mediaId": "string"
    },
    "variables": {
        "property1": "string",
        "property2": "string"
    },
    "async": true
}'

Response Example

{
    "status": "running",
    "executionId": "string",
    "workflowId": "string",
    "stepResults": [
        {}
    ],
    "variables": {},
    "startedAt": "2019-08-24T14:15:22.123Z",
    "completedAt": "2019-08-24T14:15:22.123Z",
    "error": "string"
}

Modified at 2025-12-13 02:50:35

Delete specific step

Get workflow executions