Building a basic integration flow

This document provides a step-by-step instructions on creating a basic integration flow. It is intended for platform users who have little to no experience in Flow creation.

Configuring a trigger

Every integration flow starts with a trigger. The trigger is what causes the flow to run. To help you get started, only trigger components are available for selection when you are configuring your first step.

In this example we will use Simple Trigger as an example of the first step.

  1. Select the appropriate workspace from the left hand menu. You can choose to either:

    1. Click Add new flow on the dashboard.

    2. Click Flows  Add a new flow.

This brings you to the Flow Designer page.

  • Click "give me a name" 1 to name your flow, and then enter a description in the next field. This is optional, but it is a good idea to give your Flow a meaningful name and description at the start so that you and your colleagues can easily identify its purpose later.

  • Click the Plus to add initial trigger 2:

Designer page - add initial trigger

The tabbed Step Configuration page that opens takes you through the process of configuring the first step in your flow. Different versions of this page with different options and fields will be used for configuring all of the steps in your flow.

  • Find the Component you want to use - in this case Simple Trigger. You can use the search bar 2 to find a component quickly.

  • Select it 3 and click "Choose <component name>" 4.

Setup the first step

Note: In the image below you can see that you have skipped straight to Step 5. The other steps are prepopulated with defaults that suit most scenarios. Feel free to browse the tabs but for your first flow it is best not to edit them.

All flows start with data input so the next step you need to configure is sample data retrieval.

  • Click "Retrieve sample from Simple trigger" 1

Data sample retrieval
  • Click "Continue" after the sample has been retrieved.

Data sample retrieval - Continue
  • Optionally add a description 1 of the step to help your colleagues later, then click and click "Finish step" 2 to finalize the initial trigger:

Data sample retrieval - Finish Step

Configuring action steps

You can see in the Flow Designer that you now have the option to "Add a new action". An Action step is one where you do something with the inputted data. In this case we will send an email.

  • Click "Add a new action"

Configuring Action Steps - Add a new action
  • Start typing Email Component into the search bar 1.

  • Select the component 3 and click "Choose Email" 4:

Choose Email
  • Again a few steps are configured for you. In the Input step fill in the details of the email that you want to send when this step runs.

Configure input
  • Click "Continue":

Retrieve a data sample
  • Retrieve a data sample 1 and click "Continue" 2:

  • Optionally add a step description 1

  • Click "Finish step" 2:

Summary - Finish step

Your simple flow now has enough complete steps to be published as a draft.

Note: You also have the option to continue adding actions, and if you hover over the line connecting your steps, you will see that you have the option to create multiple branches.

  • Click the Publish button to take your flow from its automatic Draft status to Published.

Publish the Flow draft

Your Flow has been published. You can now choose to run it 1, edit it 2 or delete it 3.