Create a new flow

2 minute read

Flows are acyclic directed graphs of flow-nodes. They are comprised of operational flow-nodes, which are composed of inputs, logic, and outputs. Flows are used to orchestrate data to provide a reusable, scalable, no-code/low-code way of building microservices to achieve complex integrations with existing data sources and systems.

The flows are source files and exist in the ./flows directory of your application. Editing and saving a flow will also update its corresponding source file. Flows are tightly coupled with plugins that provide flow-nodes.

To create a new flow, go to the Flows page, and click +Flow to create a new flow.

This will take you into the flow editor.

Now is a good time to give your flow a unique name and description. Click the pencil next to “New Flow”.

It will open this dialog. Give it some details for our example flow:

New flows only exist in memory until you click “Apply”. However, the editor does not allow you to save invalid flows, and currently the flow is invalid because flows require at least one flow-node for it to be considered valid. Input validation or other errors can also cause the flow to be invalid. Drag the HTTP flow-node from the Flow-Nodes > Core panel on the left, into the graph on the right. It will automatically wire-up to the Start flow-node, and auto-select the flow-node, revealing a property panel on the right-hand side. This right-hand property panel is for configuring flow-nodes, and their outputs.

Change the Status to a Number by clicking the “Selector” drop-down, and choosing “Number”. Input the value 200. The flow will be re-validated when you click on a component outside of the field, or Tab out of the field.

Now click, Apply and then click Proceed to save the flow.

You have successfully created your first flow! You can continue editing, or click Close to exit the flow editor, and return to the Flows page.