Trigger a workflow
POST/api/v1/orgs/:orgID/workflows/:workflowID/trigger
Manually trigger a workflow template to create and execute a new workflow instance.
Workflow Inputs: Include any JSON properties that your workflow expects as inputs.
Example Payload:
{
"customer_name": "John Doe",
"order_amount": 99.99,
"priority": "high"
}
Response: Returns the workflow instance ID that can be used to track the workflow execution status.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 500
Workflow triggered successfully
Bad request - Invalid variables or request body
Unauthorized - User authentication required
Forbidden - User does not have permission to trigger this workflow
Not found - Workflow template not found
Internal server error