Halt Execution¶
Stops the current workflow either by canceling the whole run immediately or by blocking any nodes that follow this node from executing. It can act as a passthrough when disabled, forwarding the input unchanged. Optional alerting can raise an exception when a halt occurs to ensure nothing else proceeds.
Usage¶
Place this node inline in your workflow wherever you may need to stop execution based on a condition. Use it as a conditional guard: convert its Disable control to an input and drive it from logic (e.g., an IF selector) to halt only under certain circumstances. Connect any data you want to pass through to the Input; optionally wire Run_After from another node solely to enforce that this node runs after that node completes.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| disable | True | BOOLEAN | When True, prevents halting and allows execution to continue; when False, halting behavior can be triggered. | False |
| method | True | BOOLEAN | Halting method. Off = Cancel Prompt (interrupts the entire run immediately). On = Block Execution (prevents any nodes downstream of this node from running). | False |
| alert_on_trigger | True | BOOLEAN | If True and a halt occurs, raises an alert/exception to ensure no further processing continues. | True |
| input | True | ANY | Any data to pass through this node. Also used to determine whether to trigger halting. | some_data_object |
| run_after | False | ANY | Optional dependency-only input to force this node to execute after the connected node. Not used for data processing. | dependency_token |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| * | ANY | Passes through the same data when not halting. If Cancel Prompt is used and halting occurs, outputs null. If Block Execution is used and supported, outputs a special blocking token that prevents downstream nodes from running. | some_data_object |
Important Notes¶
- If Disable is True, this node will not halt execution and simply forwards the input.
- A halt is only triggered when Disable is False and the Input is not null.
- Block Execution mode requires runtime support for execution blocking; if unsupported, an error will be raised advising an update.
- Alert On Trigger will raise an exception when a halt occurs, fully stopping further processing and cached execution.
- Run_After is for execution ordering only and does not affect data.
Troubleshooting¶
- Halting did not occur as expected: Ensure Disable is False and the Input is not null.
- Block Execution raised an error: Your runtime may not support execution blocking; update your environment to a version that supports it.
- Workflow fully stopped when halting: Disable Alert On Trigger if you prefer not to raise an exception and only block/cancel locally.
- Downstream nodes still executed after halting: Verify you used the desired method (Block Execution vs Cancel Prompt) and that execution blocking is supported.
- This node ran too early or out of order: Connect a node’s output to Run_After to enforce ordering.