Sub Flow

Execute flows as reusable components

Triggers

Events from this node that can start a flow. Add one from Choose a trigger.

Event-based trigger for sub-flow execution. Marks this flow as callable from other flows.

Settings

Field	Type	Required	Description
Input Parameters Schema	List		Define input parameters that parent flows must provide. No special characters and space allowed.

Output

Later steps use this data through Current Trigger in the $ picker. For example, isSubFlow is $trigger.output.isSubFlow.

json

{
  "isSubFlow": false,
  "params": {},
  "parentFlowId": "string",
  "parentRunId": "string",
  "triggerType": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`isSubFlow`	Yes / No	Indicates this flow was triggered as a sub-flow
`params`	Object	Input parameters passed from parent flow, defined by inputSchema.
`parentFlowId`	Text	ID of the parent flow
`parentRunId`	Text	ID of the parent flow run
`triggerType`	Text	Type of trigger (always 'startSubFlow')

Steps this node can perform. Add one from Add a step, then pick the action.

This Sub-Flow node runs a Sub-Flow that includes a Sub-Flow Trigger to start it and a Return Action to send outputs back to the parent Flow.

Settings

Field	Type	Required	Description
Select your Sub-Flow	Choice (loaded from your account)	Yes	Select the flow to execute (only flows with 'Start Sub Flow' trigger are shown)
Input Parameters	Object		Map values to sub-flow input parameters
Execution Mode	Choice		Wait: pauses until sub-flow completes. Fire and Forget: continues immediately Options: `Wait for Completion`, `Fire and Forget` Default: `wait`

Output

Later steps use this data by picking this step in the $ picker. For example, failureReason is $.<step ID>.output.failureReason.

json

{
  "failureReason": "string",
  "subFlowCompleted": false,
  "subFlowFailed": false,
  "subFlowRunId": "string"
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`failureReason`	Text	Why the sub-flow did not complete, for example subflow_execution_failed
`subFlowCompleted`	Yes / No	True when the sub-flow finished through its Return action (wait mode only). The values returned by the sub-flow sit next to this field at the top level of the output, keyed by the Return action's output mapping.
`subFlowFailed`	Yes / No	True when the sub-flow failed. Later nodes only see it when this node's error handling is set to continue.
`subFlowRunId`	Text	ID of the sub-flow run (wait mode only)

This Return Action marks the end of a Sub-Flow. It should follow the Sub-Flow Trigger and sends the Sub-Flow's outputs back to the parent Flow.

Settings

Field	Type	Required	Description
Output Values	Key–value pairs		Define values to return to the parent flow

Output

Later steps use this data by picking this step in the $ picker. For example, returned is $.<step ID>.output.returned.

json

{
  "returned": false
}

Example values show the shape of the data, not real values. See Using data from earlier steps.

Field descriptions

Field	Type	Description
`returned`	Yes / No	Indicates successful return