Workflow Input
Workflow ingress interface. Injects external API inputs or custom-node caller parameters.
Overview
Defines the external ingress interface of a workflow. When a workflow is saved as a reusable Custom Node or invoked externally via the execution engine API, the dynamic output ports configured on Workflow Input become the input ports of that Custom Node.
A workflow may contain at most one Workflow Input node. During interactive canvas testing, each port can also be assigned a fallback test value in the inspector so the workflow can be run standalone.
When to Use
- Packaging a multi-node cryptographic sub-pipeline (such as HKDF key derivation followed by AES-GCM encryption) into a reusable Custom Node with clearly typed input ports.
- Defining the formal input contract for an externally triggered workflow.
Parameter Configuration
Workflow Input is configured by managing its dynamic output ports in the property inspector:
- Constraint: Only one
Workflow Inputnode can exist per workflow graph. - Port Definition: For each port you add, you configure its Name, Data Type (
Bytes,String,Int, orBool), and optional standalone default value.
Port I/O Specification
See Ports & Connections for general wiring rules, data type colors, and dynamic port creation.
Input Ports
This node has no input ports.
Output Ports
| Attribute | Specification |
|---|---|
| Port Nature | Dynamic / Variable Output Ports |
| Initial Default on Canvas | Starts with 0 output ports (outputs: []) until you add or connect ports. |
| Port Count Range | 0 or more output ports. |
| Allowed Data Types | Bytes, String, Int, or Bool. |
| Adding & Managing Ports | Add, remove, rename, and set the data type of each output port in the inspector or by dragging from the [+] handle on the right side of the node card to a downstream node's input port. |
| Evaluation & Ordering Rule | The top-to-bottom order of output ports on Workflow Input defines the top-to-bottom order of input ports on the resulting Custom Node. |
Error Cases
When any of the following conditions occurs at runtime, this node transitions to an ERROR state and downstream nodes connected to its outputs do not execute.
| Error Code | Default Engine Message | Trigger Condition |
|---|---|---|
INPUT_CONSTRAINT_VIOLATION |
An input port value violates its declared constraint (length or range) | Raised when a value arriving at a constrained port violates its declared byte-length or integer-range constraint. |
Examples
Defining Inputs for a Reusable Envelope-Encryption Custom Node
Expose Key and Plaintext inputs for a custom node.
- Place a single Workflow Input node on the canvas.
- Drag from its
[+]output handle to theKeyport of AES Encrypt, and drag again from[+]to thePlaintextport. - Rename the two created ports to
KeyandPlaintextin the inspector.