Flow Nodes

Overview

A typical flow node looks like this:
type: transform-data
name: Configure Object Fields
config:
output:
developerDefinedField: Field Value
userDefinedField:
$ui:
schema:
type: string
links:
- key: next-node-key
Here is what properties mean:
  • type - one of the flow node types provided by integration.app. You can find the full list of node types in sub-pages of this page.
  • name - how this node will be called in the UI - both in Integration Console and in the flow configuration UI for your users.
  • config - configuration of the node. Each node type has its own configuration format. You can find it on the corresponding node's page.
  • links - list of nodes that run after the current node.

Config

When configuring node, sometimes you will use plain values (like This is value or 5), and sometimes you want the value to come form elsewhere:
  • Flow Parameters you provide when creating the flow.
  • ​Flow Run Context​
  • Your users via Configuration UI.
  • Other nodes' configuration (you don't want to duplicate value in two places!).
You can point to those values using special field names:
  • $var for pointing to to other variables (flow parameters, run context, other nodes)
  • $ui for configuring how to get this value from the UI. This option is not available for every node type and every parameter - please refer to the specific node type's documentation to see what is possible.

Variables

When you want to use a variable for a config parameter, do it like this:
parameterFromVariable:
$var: $.<object>.<key>
You have the following variables available:
  • flow contains the current flow. You can refer to the flow parameters ($.flow.parameters.paramName), other nodes ($.flow.nodes.some-node.config.configParam), or anything else from the Flow object.
  • context contains the current Flow Run Context. Use it to use flow input as well as outputs of previous nodes.

UI

Whenever you need to get a part of the node config from the User Interface, use $ui key, like this:
type: transform-data
name: Configure Object Fields
config:
output:
$ui:
schema:
type: string
default: Default Value
​
The structure of the $ui object depends on a node type you use, except the default key that works in the same way for all nodes. If user never configures the node, the default value will be used instead of user-provided value. When user configures the node, the default value will be pre-set in the UI by default.
Copy link
Outline
Overview
Config
Variables
UI