Use the Exit operator to terminate a workflow at a specific point and optionally define the output schema for data returned when the workflow completes. This enables information from the workflow to be easily integrated with other systems or workflows.
How to use
Add the operator: Drag and drop the Exit operator to the place you want to stop the workflow.
Add parameters: Open the Properties panel and click on + Add parameter to create your output schema. If you need a raw JSON output, click on the Convert to JSON arrow icon to switch the operator to JSON mode.
Parameters:
Type: Decide what data your parameter will hold (e.g., Text, Number, Boolean, etc.). The default type is Short text.
Name: Give your parameter a name. This is how you'll refer to it from a parent workflow or external system.
Description: Optionally, you can describe what the parameter is for.
Consistency across all Exit operators: For consistency, ensure all Exit operators in your workflow are updated with the right parameter values. Use the Event Preview tab to see how your data will look.
Parameters Default Values
Parameters Default Values
Short/Long text: empty string
JSON: empty
Number: 0
Boolean: false
File: empty
Using output schema with nested workflows
Define the structure and content of results returned by the nested workflow, ensuring consistent outputs are passed on to the parent workflow. You can reference the output schema of a nested workflow without running it. This allows you to design the parent workflow based on the output of the nested workflow.
JSON mode
If your workflow needs a custom data structure, you can convert an Exit operator to JSON mode. This allows for a flexible raw JSON output.
Click on the Convert to JSON icon in the Exit operator's Properties panel.
The Properties panel now shows the output JSON, and the operator's icon is changed to indicate it's now in JSON mode.
In JSON mode, you might need to adjust the parent workflow for various data outputs, as not all Exit operators follow a single structure.