Flow - Execute
Type identifier:
flow:executeCategory: Flow Operations
Description
Runs another Flow, optionally scheduling it for a later run. Allows Flows to call other Flows, passing inputs and receiving results. Supports both synchronous (inline) and scheduled (background) run modes.
Input Handles
Handle | Data Type | Required | Description |
|---|---|---|---|
|
| Yes* | Execution trigger input (*unless data-only) |
|
| No* | When to run (*only if |
| Varies | Varies | Dynamic inputs matching target Flow trigger |
Input Handle Details
trigger
- Type:
trigger - Notes: Only present when the target Flow's trigger node has
isDataOnly: false
scheduledAt
- Type:
date Notes:
- Only present when
isScheduledistrue - If the scheduled time is in the past, the Flow runs immediately
- Only present when
Dynamic Input Handles
Input handles are dynamically generated based on the target Flow's trigger node incomingData configuration. The handle ID follows the pattern {type}:{incomingDataId}.
Output Handles
Handle | Data Type | Description |
|---|---|---|
|
| Emitted when the child Flow run succeeds |
|
| Emitted when the child Flow run fails |
|
| The run ID (only if |
| Varies | Result from each |
Output Handle Details
flowExecutionId
- Type:
string(CUID2 format) - Notes: Only present when
isScheduledistrue. The ID can be used to track or cancel the scheduled run.
Dynamic Result Handles
When isScheduled is false, output handles are created for each flow:result node in the target Flow. The handle ID is the result node's nodeId, and the data type matches the result node's configured type.
Configuration Options
Property | Type | Required | Default | Description |
|---|---|---|---|---|
|
| Yes |
| Display label for the node |
|
| Yes |
| CUID2 of the target Flow |
|
| Yes |
| Node ID of the trigger in the target Flow |
|
| No |
| Whether to schedule for a later run |
Configuration Details
flowId
- Type:
string(CUID2 format, 25 characters) - Validation: Must reference an existing Flow in the current Space
- Notes: Select from the Flow picker in the node configuration
triggerNodeId
- Type:
string - Validation: Must reference a
flow:triggernode in the target Flow - Notes: Automatically set when selecting a Flow with the Flow picker
isScheduled
- Type:
boolean - Default:
false Notes:
- When
true, the Flow is queued to run in the background - When
false, the Flow runs inline and results are available immediately
- When
Behaviour
Execution Flow
- Node receives trigger on the
triggerinput handle - Fetches the target Flow version and validates the trigger node
- Resolves all input values from connected handles
- Maps input values to the target Flow's incoming data Schema
- Either schedules or runs the Flow based on
isScheduled
Synchronous Run (isScheduled: false)
- Runs the target Flow inline
- Result node outputs are made available on output handles
- UX nodes (
ux:message,ux:action) automatically pass output to the parent Flow - Triggers
successon completion orerroron failure (see Child Flow Failure Propagation)
Scheduled Run (isScheduled: true)
- Reads the
scheduledAtinput - If the scheduled time is in the past, runs immediately
- Queues the Flow to run in the background
- Outputs the
flowExecutionIdfor tracking - Triggers
successafter scheduling
Child Flow Failure Propagation
A synchronous child Flow fails when one of its nodes fails with an error that the node does not handle itself, that is, the failing node has no connected error output. This includes data nodes (for example a data:expression that throws) whose failure would otherwise only resolve to null in a consumer that tolerates missing data, such as flow:result. Errors that are only written to the run log (for example Missing required property '…' in source schema while mapping inputs) do not fail the child Flow, and a failing node whose error output is connected is treated as handled.
When the child Flow fails:
- If this node's
erroroutput is connected, it triggerserrorand sets itserrorresult to{ message }, where the message names the failing child Flow node and its error.successis not triggered. - If this node's
erroroutput is not connected, the failure is unhandled in the calling Flow as well: the node fails, and the failure keeps propagating to the next callingflow:executenode, up to the first one with a connectederroroutput. - When the target trigger is data-only and this node is resolved as data, its result outputs fail with the child Flow failure when they are read, so the failure still propagates to the calling Flow (even through consumers that tolerate missing data).
Input Mapping
For each incoming data item in the target trigger:
- Resolves the corresponding input handle value
- For
entitytypes, applies the standard Record fields - Maps the value to the target Schema structure
Result Propagation
ux:messageandux:actionoutputs are automatically passed to the parent Flowflow:resultoutputs are captured and available on the corresponding output handle
In Flows v2, inline child results may contain sensitive values. These values retain their sensitivity and can be used by downstream nodes or passed through further inline child Flows, but cannot be returned as the top-level Flow run result. Wrapped Secret Values remain disallowed in child results. Run inspection does not reveal sensitive payloads.
Edge Cases
Scenario | Behaviour |
|---|---|
Target Flow not found | Error: "flow not found" |
Trigger node not found | Error: "targetTriggerNode not found" |
Invalid | Error: "scheduledAt is not an Instant" |
| Runs immediately with info log |
Target Flow throws exception | Triggers |
Child Flow node fails, | Triggers |
Child Flow node fails, | Fails this node; propagates to the calling Flow |
Required input missing | Error during input resolution |
Examples
Synchronous Run
{
"type": "flow:execute",
"data": {
"label": "Execute Process Order",
"flowId": "clx1234567890abcdefghij",
"triggerNodeId": "node_abc123",
"isScheduled": false
}
}Input Handles (assuming target trigger has orderId string input):
trigger(trigger)string:orderId(string)
Output Handles (assuming target has one result node):
success(trigger)error(trigger)node_result_xyz(matches result node type)
Scheduled Run
{
"type": "flow:execute",
"data": {
"label": "Schedule Email Reminder",
"flowId": "clx9876543210zyxwvutsrq",
"triggerNodeId": "node_def456",
"isScheduled": true
}
}Input Handles:
trigger(trigger)scheduledAt(date)- Dynamic inputs from target trigger
Output Handles:
success(trigger)error(trigger)flowExecutionId(string)