Execute Workflow
POST/api/automation/workflows/:workflow/execute
Manually run a published workflow. The run is queued asynchronously: the response returns the new execution record immediately (status pending) - poll Get Workflow Execution for progress and step-by-step results.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Body fields: trigger_payload (optional object) - data made available to the trigger node, in place of a real trigger event.
Only published workflows can be executed. Returns 403 when workflow automation is disabled for the account.
Path param: workflow = workflow id.
If the workflow is in preview mode, the manual run is a preview run too: the returned execution carries previewMode: true and every state-changing step is skipped.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.