> ## Documentation Index
> Fetch the complete documentation index at: https://docs.quixa.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Stop Flow Component

> Graceful workflow termination, branch-level early exits, and custom output status payloads.

The **Stop Flow** node is a terminal node used to safely halt workflow execution, enforce early exit conditions, or terminate a specific parallel branch without failing parent processes.

***

## 1. Termination Scopes

In the **Stop Configuration Dialog**, you can select between two operational scopes:

### A. Terminate Whole Flow (`terminate-flow`)

* Immediately cancels all remaining active and pending nodes across the entire workflow graph.
* Sets internal status `__flow_terminated__ = true`.
* Useful when encountering fatal preconditions (e.g. invalid authentication, unrecoverable data integrity failures) where subsequent steps must never be attempted.

### B. Terminate Current Branch (`terminate-branch`)

* Safely concludes execution of only that specific branch path.
* Other concurrent parallel branches and independent nodes continue executing without interruption.
* Ideal for multi-branch pipelines where one branch reaches a completed state early while other branches continue background tasks.

***

## 2. Exit Status & Response Payloads

You can customize how the termination is recorded in the execution audit logs:

* **Exit Status**:
  * `Completed` (Green): Normal, expected early conclusion.
  * `Warning` (Amber): Completed with business rule flags.
  * `Failed` (Red): Abrupt termination due to unmet requirements.
* **Exit Message**: A human-readable reason (e.g. *"Account already activated; skipping provisioning"*).
* **Custom Output Payload (JSON)**: An optional structured JSON object returned as the workflow's final execution output.

***

## 3. Visual Canvas Representation

* Stop nodes are rendered in distinctive crimson (`#ef4444`) with an octagonal stop icon.
* **Terminal Geometry**: Stop nodes have **no outgoing output handles**, visually conveying that no further downstream execution can follow.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.