Workflows

Run a workflow

put/v4/workflows/{workflowId}/run

Request

  • Base URL: https://api.kadoa.com
  • URL: https://api.kadoa.com/v4/workflows/{workflowId}/run
  • Auth: API key in header x-api-key

Path parameters

workflowIdstring required

The ID of the workflow to run

Request body

variablesobject

Optional variables to pass to the workflow execution

limitnumber

Optional limit for the number of records to process

previewboolean

Rerun the preview of a PREVIEW-state workflow instead of starting a production run

Example request

{
  "limit": 100
}

Response

Workflow started successfully

messagestring
jobIdstring

The ID of the created job

statusstring

The status of the job

Example response

{
  "message": "Workflow started",
  "status": "running"
}

Changes

No recorded changes to this operation across all 1 revision of this API.