Create a Workflow (Workflow Editor)
Building a Workflow
This page allows users to create and/or edit existing workflows. Using the Workflow Editor, users are able to drag and drop blocks from the list of integrations on the right.
Before You Begin
Ensure that you are on the "Workflow Editor" page and that you have the appropriate permissions to interact with the required integrations. This page is accessible by either clicking the "+ Create" button to name and create a new workflow, or by clicking on an existing workflow from the list.
About the Task
This is how users build workflows in the system.
After creating a workflow, confirm the name which should be in the upper left-hand corner of the page. Each workflow contains a "start block" and an "end block" which designate the start and end respectively of a particular workflow.
In every workflow, you have the ability to create variables which can be referenced throughout the workflow. To create a variable, select the down arrow on the start block. This will reveal a few options for your new variable:
Checking the "advanced" box on the start block will reveal additional options for your variable: "scope", "type", and the "required" option.
|Name||This is the name of your variable.|
This is the default value of your variable.
|Scope||The scope of a variable is its visibility, i.e. whether other workflows calling this workflow can see this variable.|
|Type||This variable can be a string, boolean, integer, double, object, etc.|
|Required||Selecting this indicates the variable MUST have a value for the workflow to execute.|
|Input||Selecting this indicates to the system that this variable is an input for the workflow.|
|Output||Selecting this indicates to the system that this variable is an input for the workflow.|
|Delete||This removes the variable from the workflow.|
|Intermediate||Accessible from some outside flows|
|Local||Only accessible from inside this flow|
|Global||Accessible from all outside flows|
To access the cURL of a workflow, press the down arrow on the start block. Then, press the cURL button. This will reveal the cURL for this workflow. The cURL provides a sample of the RESTful endpoint for this specific workflow. If there are variables defined above, those will be present in the sample as well. You can use this URL to test calling the workflow from a remote system (assuming it has access to the platform).
On the right-hand side of the page, you will see groups of API calls that can be dragged into the workflow. To find a particular API call, select its respective folder and navigate the tree of integrations. You can also search for a specific API call using the search icon at the top of the right-hand side of the section.
Naming a Block
After finding the desired API call, drag it to the appropriate place to be executed in the workflow. Each block has a title (which is the title of the specific API call) as well as a name (which you can define). By default, each block is assigned a unique letter and number combination. You can edit this name by clicking of the default name and renaming it something more descriptive.
After a block is position in the correct place (it can always be changed later) and has an appropriate name (or the default name), you need to fill in the variables that are required for that API block. These variables will vary depending on the specific API call. "AuthKey" is the authentication key for this integration. For more information on authentication, see the authentication section below.
Disabling a Block
You also have the ability to check the box and "disable" this block from the workflow. If a block was needed previously and not needed now, this provides an easy way to disable the block without changing the workflow.
Block actions can be accessed by pressing the three vertical dots button at the top of the block. There are three actions you can perform on a block:
|Move||Allows you to move the block somewhere else in the workflow. This can also be done simply by dragging and dropping the block into a new location within the workflow.|
|Clone||Allows you to make a copy of the block.|
|Delete||Allows you to delete a block from the workflow.|
Adding Authentication Keys
To add authentication, click on the "Auth" button located on the upper-right side of the page. Next, press "Add Authentication". To add an authentication you must fill out the following parameters:
|Name||This is the name of the authentication. You should ensure that this is unique and has enough details for other users to know what system this authentication is for.|
|Description||This is the description of the authentication.|
|Service||This is the service or integration for which you are adding an authentication. The dropdown menu will reveal a list of automatically populated integrations that are loaded on the platform. After selecting a service, a pop-up will appear will require properties to fill out in order to connect to the integration.|
After selecting a service, you will need to fill out the required properties to connect to the integration. Additionally, each property may be set to either "Read" or "Override".
|Read||Allows other users to see this information. NOTE: If this is not selected, the parameters entered here are not visible again through any part of the system.|
|Override||This allows the parameter to be overridden in the workflow. If you are looking to pass in a set of IPs to make a change to, this is where you tell the system this particular parameter can be overridden in-line of the workflow.|
Viewing Existing Authentications
To view existing authentications, click the "Auth" and press "Authentications". A pop-up will appear that lists the authentications within the workflow.
Saving a Workflow
To save a workflow, press the save icon located at the top right of the screen.