Flow - Trigger
Type identifier:
flow:triggerCategory: Flow Operations
Description
Entry point for Flow runs. Defines the inputs that a Flow accepts and makes them available to downstream nodes. A Flow must have at least one trigger node; each run starts at the trigger node it selects. A Canvas Flow literal run is the exception: its definition must declare exactly one trigger node.
Input Handles
This node has no input handles. It is the entry point of the Flow.
Output Handles
Handle | Data Type | Description |
|---|---|---|
|
| Execution trigger output (unless |
|
| Record data for |
| Varies | Data output for each configured incoming data |
Output Handle Details
trigger
- Type:
trigger - Notes: Only present when
isDataOnlyisfalse. Starts the run.
Dynamic Data Handles
Output handles are dynamically generated based on the incomingData configuration. The handle ID follows the pattern {type}:{incomingDataId} where:
typeis the data type (entity,string,number,boolean,date,object,array,file,content)incomingDataIdis the unique identifier for the incoming data item
Configuration Options
Property | Type | Required | Default | Description |
|---|---|---|---|---|
|
| Yes |
| Display label for the node |
|
| No |
| If true, the Flow runs in data-only mode |
| array | No |
| Array of incoming data definitions |
Configuration Details
isDataOnly
- Type:
boolean - Default:
false Notes:
- When
true, the Flow runs without a trigger output handle - Data-only Flows directly process to result nodes
- Used for Flows that are called synchronously and return data immediately
- When
incomingData
- Type: array of objects, each with
id(string),incomingDataId(string), andtype;typeis one of:entity,string,number,boolean,date,duration,file,object,geojson,array,content - Notes: Each incoming data item creates a corresponding output handle
Record Incoming Data
entity-type incoming data has additional properties:
Property | Type | Required | Default | Description |
|---|---|---|---|---|
|
| Yes | — | CUID2 of the target Schema |
|
| Yes | — | Display name |
|
| No |
| Whether input is required |
|
| No |
| Show trigger on Record detail view |
|
| No |
| Show trigger on Record table view |
|
| No |
| Auto-trigger on Record creation |
|
| No |
| Auto-trigger on Record update |
|
| No |
| Auto-trigger on Record deletion |
|
| No |
| Display order |
Behaviour
Execution Flow
- The run begins at the trigger node
- Incoming data values are read from the run's inputs
- Each incoming data item is validated against its type schema
entity-type inputs are enriched with standard Record fields (such asid,createdAt,updatedAt)- Results are set on output handles for downstream consumption
Data-Only Mode
When isDataOnly is true:
- No
triggeroutput handle is created - The Flow processes directly to connected
flow:resultnodes - Used for synchronous runs that return data immediately
Standard Mode
When isDataOnly is false:
triggeroutput handle starts the downstream nodes- The Flow runs asynchronously through the connected node graph
Record Input Handling
Record inputs can be provided in two ways:
- Record ID (string): The Record is looked up
- Record object: The raw Record data is validated against the Schema
Record lifecycle settings can start the Flow on Record creation, update, or deletion. The lifecycle event supplies the Record ID through the configured Record input. A missing Record produces a null output; when triggerOnDelete is enabled, deleted Records can be included in the lookup.
For Record inputs, the output includes:
id: Record identifiercreatedAt: Creation timestampupdatedAt: Last update timestampcreatedById: Creator user IDupdatedById: Last updater user ID- All Record properties converted to ID-based format
Some nodes convert these ID-based keys back to field names. In a Data - Expression, for example, Record fields are read by field name, not field ID.
Absent optional Record fields do not prevent the Flow from running. They are omitted from the output, including fields inside nested objects and array items. Explicit null and populated values are preserved.
Raw Record values are validated and mapped using the active Schema when the trigger runs. Bare file references in raw Record values are verified when the trigger runs; if verification fails, the run fails.
Edge Cases
Scenario | Behaviour |
|---|---|
Missing required input | Error: "No input provided for..." |
Invalid Record data | Error: "Invalid schema data provided for..." |
Schema not found | Trigger run fails |
Record not found (when ID given) | Output is |
Deleted Record with | Deleted Record is included in the lookup |
Examples
Basic Trigger with String Input
{
"type": "flow:trigger",
"data": {
"label": "Flow - Trigger",
"isDataOnly": false,
"incomingData": [
{
"id": "input1",
"incomingDataId": "input1",
"type": {
"type": "string",
"display": "text",
"name": "User Name",
"required": true
}
}
]
}
}Output Handles:
trigger(trigger)string:input1(string)
Record Trigger with Auto-Create
{
"type": "flow:trigger",
"data": {
"label": "On Contact Created",
"isDataOnly": false,
"incomingData": [
{
"id": "contact",
"incomingDataId": "contact",
"type": {
"type": "entity",
"schemaId": "clx1234567890abcdefghij",
"name": "Contact",
"required": true,
"triggerOnCreate": true,
"showOnEntity": false
}
}
]
}
}Output Handles:
trigger(trigger)entity:contact(object)
Data-Only Trigger
{
"type": "flow:trigger",
"data": {
"label": "Calculate Total",
"isDataOnly": true,
"incomingData": [
{
"id": "items",
"incomingDataId": "items",
"type": {
"type": "array",
"items": { "type": "number" },
"name": "Items"
}
}
]
}
}Output Handles:
array:items(array) — notriggerhandle