POST
/
workflows
/
execute
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/execute \
  --header 'Content-Type: application/json' \
  --data '{
  "workflowId": "1",
  "loginId": "1",
  "params": {
    "origin": "New York",
    "destination": "Los Angeles"
  },
  "timeout": 1800
}'
{
  "executionId": 123,
  "status": "Enqueued",
  "message": "Workflow execution started successfully"
}

Body

application/json
​
workflowId
string
required

ID of the workflow to execute

Example:

"1"

​
loginId
string
required

ID of the login to use for authentication

Example:

"1"

​
params
object
required

Runtime parameters for the workflow execution

Example:
{
  "origin": "New York",
  "destination": "Los Angeles"
}
​
timeout
integer

Optional timeout in seconds for the execution (defaults to 1800 seconds / 15 minutes)

Required range: x > 0
Example:

1800

Response

200
application/json
Workflow execution started successfully
​
executionId
integer
required

Unique identifier for the execution

Required range: x > 0
Example:

123

​
status
string
required

Current status of the execution

Example:

"Enqueued"

​
message
string
required

Additional information about the execution

Example:

"Workflow execution started successfully"