Run a workflow

PUT /v4/workflows/{workflowId}/run

Run a workflow

cURL

curl --request PUT \
  --url https://api.kadoa.com/v4/workflows/{workflowId}/run \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "variables": {},
  "limit": 100
}
'

200

{
  "message": "Workflow started",
  "jobId": "<string>",
  "status": "running"
}

Authorizations

x-api-key · string · header · required

API key for authentication

Path Parameters

workflowId · string · required

The ID of the workflow to run

Body

application/json

variables · object

Optional variables to pass to the workflow execution

limit · number

Optional limit for the number of records to process

Example:

100

Response

200

application/json

Workflow started successfully

message · string

Example:

"Workflow started"

jobId · string

The ID of the created job

status · string

The status of the job

Example:

"running"