Flow Studio
Cancel Workflow Node
Sending a cancellation signal to a running workflow execution — the CancelWorkflowNode config, how the target execution responds, and using this in saga compensation.
Node Configuration
{
"nodeType": "CancelWorkflow",
"name": "cancelPayrollRun",
"config": {
"executionId": "$output.startPayrollRun.executionId",
"reason": "Cancelled by orchestrator: payroll period already processed",
"waitForCancelled": false
}
}Configuration Fields
| Field | Type | Description |
|---|---|---|
executionId | string / expr | The execution ID to cancel. Must be a running or suspended execution within the same tenant. |
reason | string / expr | Human-readable cancellation reason recorded in the execution audit log. |
waitForCancelled | bool | When true, the node suspends until the target execution reaches Cancelled status. Default: false. |
Node Output
{
"executionId": "exec-payroll-abc123",
"status": "cancellation-requested",
"requestedAt": "2026-05-25T10:05:00Z",
"reason": "Cancelled by orchestrator: payroll period already processed"
}Cancellation Behaviour
Cancellation is a signal, not an immediate stop. The target execution:
- Completes the currently-executing node (cannot interrupt mid-execution)
- Checks for a cancellation signal before starting the next node
- Transitions to
Cancelledstatus at the next safe checkpoint - HIL tasks (approvals, forms) waiting on the execution are automatically withdrawn
Already-completed executions: Sending a cancel signal to a
Completed or already-Cancelled execution is a no-op — the node succeeds and the output reflects the current status. This is safe to call without checking status first.