Skip to main content
POST
/
workflows
/
execute
Execute a workflow
curl --request POST \
  --url https://api.kaizenautomation.com/workflows/execute \
  --header 'Content-Type: application/json' \
  --data '
{
  "params": {
    "origin": "New York",
    "destination": "Los Angeles"
  },
  "workflowId": "<string>",
  "workflowName": "<string>",
  "loginId": "<string>",
  "name": "User batch execution",
  "timeout": 10800,
  "useProxy": false,
  "startBlockId": "1",
  "batchId": "batch_123",
  "isTest": false
}
'
{
  "executionId": "1",
  "status": "Processing",
  "message": "Workflow execution started successfully"
}

Body

application/json
​
params
object
required

Runtime parameters for the workflow execution

Example:
{
  "origin": "New York",
  "destination": "Los Angeles"
}
​
workflowId
string

ID of the workflow to execute. Either workflowId or workflowName must be provided.

​
workflowName
string

Name of the workflow to execute. If provided, the workflow will be looked up by name within the organization. Either workflowId or workflowName must be provided.

​
loginId
string

ID of the login to use for authentication

​
name

Optional name for the execution (string or number, automatically converted to string)

Example:

"User batch execution"

​
timeout
integer

Optional timeout in seconds for the execution (defaults to 10800 seconds / 3 hours)

Example:

10800

​
useProxy
boolean
default:false

Whether to use a proxy for this execution

​
startBlockId
string

Optional ID of the block to start execution from

Example:

"1"

​
batchId
string

Optional ID of the execution batch to assign this execution to

Example:

"batch_123"

​
isTest
boolean
default:false

Whether this execution is a test run

Response

Workflow execution started successfully

​
executionId
string
required

ID of the created execution

Example:

"1"

​
status
string
required

Status of the execution

Example:

"Processing"

​
message
string
required

Message about the execution

Example:

"Workflow execution started successfully"