Workflows Overview
Accessible to Owners and Managers, the Workflows Module allows the creation of automated processes, incorporating triggers and steps to perform actions like automated messaging and auto-assignment.
Last updated
Accessible to Owners and Managers, the Workflows Module allows the creation of automated processes, incorporating triggers and steps to perform actions like automated messaging and auto-assignment.
Last updated
This module is only accessible to Owners and managers.
This module is accessed from the side navigation menu under the menu item Workflows.
The Workflows Module is a visual Workflow builder used to automate processes. Workflows can incorporate elements like Contact data to build automation such as automated messaging, auto-assignment, and more. A Workflow consists of a Trigger and one or more Steps.
Use the 🔍 at the top of the Workflows Module to quickly find a Workflow.
The main page of the Workflows Module is a listing page. It provides an overview of the Workflow in your Account.
Below are the actions that can be performed in Workflows:
Creating a New Workflow
Saving a Workflow
Publishing a Workflow
Stopping a Workflow
Editing a Workflow
Creating a New Workflow
To create a Workflow:
Navigate to the Workflows main page.
Click Add Workflow.
Name the Workflow.
Write the Description.
Choose the Inbox: Specify the inbox to which the workflow will be applied. (Optional)
Click Create.
Once the Workflow has been created, it will open in the Workflow Builder. Start building the Workflow by selecting a Trigger.
Limitation: Maximum 100 Workflows per Account.
The pre-built Workflow will be created. Update the steps highlighted in red to save or publish the Workflow.
Saving a Workflow
A Workflow can be saved by clicking the Save button in the Top Bar of the Workflow Builder.
Step configuration errors must be resolved before a Workflow can be saved.
Publishing a Workflow
To start a Workflow, you need to publish it. A Workflow can be published from two places:
From the Actions menu in the Workflows listing page
With the Publish button inside the Workflow Builder
Once the Workflow is published, it will run. Contacts who meet the trigger criteria will enter the Workflow. To edit a Published Workflow, you need to stop the Workflow.
Stopping a Workflow
When a Workflow is stopped, all enrolled Contacts will be ejected immediately. They will not be re-enrolled into the Workflow when it is re-published.
A Workflow can be stopped from two places:
From the Actions menu in the Workflows listing page
With the Stop Button inside the Workflow Builder
Once a Workflow is stopped, it may be edited.
Editing a Workflow
Editing takes place in the Workflow Builder. In the Actions menu on the Workflows listing page, click Open in Builder. Once inside the Workflow Builder, you can edit the Workflow.
A Workflow can only be edited when stopped.
Workflow Columns
Each Workflow will have the following associated information in its columns.
Workflow Status
The Workflow Status is used to determine if the Workflow is currently running. There are three possible statuses:
Draft: A Workflow that has never been published
Published: A Workflow that is currently implemented
Stopped: A previously published Workflow that has been stopped
Other Columns
Each Workflow has additional columns detailed below.
Header | Description |
Name | Displays the name |
Description | Displays the description |
Updated At | Displays the last updated date |
Created At | Displays the date it was created |
Actions Menu
The last column in the Workflows row contains the Actions Menu. The following actions can be performed here:
Action | Description |
Publish Workflow | Only shown when Workflow is in Draft or Stopped |
Stop Workflow | Only shown when Workflow is Published |
Edit Name/Description | Allows editing of Workflow name or description |
Clone | Creates a duplicate Workflow in Draft Status |
Delete | Delete the workflow |
To open the Workflow Builder, you need to create a Workflow or edit a Workflow. The Workflow Builder is a visual editor where Steps can be added, removed, and configured. It consists of four main sections:
Top Bar
Assistive Tools
Canvas
Configuration Drawer
The Top Bar
The top bar is used to manage key Workflow items like their name, description, errors in step configuration, and status. The elements of the top bar are as below.
Name | Displays Name and allows editing of Name or Description |
Edit | To edit workflow name or description |
Save Button | Allows Workflow to be saved |
Status Button | Allows Workflow to be published or stopped |
Assistive Tools
The five Assistive Tools are designed to help you navigate the Canvas:
Zoom In
Zoom Out
Center
Canvas
Canvas is the drag-and-drop interface that provides an overview of the Workflow. It allows the user to observe the logic and sequence of a Contact's journey during an event. Actions such as building new Steps, dragging or dropping Steps, and connecting Steps take place here.
Configuration Drawer
To configure a Trigger or Step, click on the Trigger or Step block to open its configuration drawer. The actions possible in the configuration drawer include:
Edit the Step name
Define the action of the trigger event or Step
What will happen to my Contacts if I stop a published Workflow?
If a Workflow is stopped, all enrolled Contacts will be immediately ejected from the Workflow. They will not be re-enrolled into the Workflow if it is re-published.
Why did my Workflow end before it was completed?
A Workflow may end prematurely for the following reasons:
The Workflow was stopped - If a Workflow is stopped, all enrolled Contacts will be immediately ejected from the Workflow.
The Contact fell under the Failure Branch and there was no continuing journey - Contacts may fall under a Failure Branch if they provide invalid responses or do not meet specified conditions. If there are no steps configured under the Failure Branch, the Workflow will end. It is advisable to configure steps under the Failure Branch so Contacts may continue their journey if they land here.
Ask a Question - Timeout - The Ask a Question Step has a default timeout period of 7 days. If Contacts do not respond within the defined or default timeout period, the Workflow will end. It is advisable to create a Timeout Branch and add Steps for Contacts to continue their journey in the event of a timeout. Read more about the Ask a Question Step here.
Assign to - Timeout - The Assign To Step has a default timeout period of 7 days. If an assignee who fulfills the assignment logic cannot be found within the defined or default timeout period, the Workflow will end. It is advisable to create a Timeout Branch and add Steps for Contacts to continue their journey in the event of a timeout. Read more about the Assign To Step here.
Branch Condition - Else - Contacts who do not meet the required conditions of a branch will fall under the Else branch. If no steps are configured under this branch, the Workflow will end. It is advisable to configure Steps under the Else branch so Contacts may continue their journey if they land here. Read more about Branch Steps here.
Send a Message - Fail - If a message is not sent for any reason (e.g., messaging window closed, network connection issues), the Contact will exit the Workflow.
If I manually close an ongoing conversation with an enrolled Contact on the platform, will the Workflow end?
No, the Workflow will continue even if the conversation is manually closed on the platform. The Workflow will only end if the conversation closes in the Workflows Module.
Can a Contact re-enter the same Workflow they are currently enrolled in it?
A Contact cannot re-enter a Workflow they are currently enrolled in. The Contact has to exit the Workflow and meet the criteria for the trigger event again to repeat or re-enter a Workflow.
What if a Contact triggers more than one Workflow at the same time?
Both Workflows will be executed concurrently.
I have updated a Contact Field value but the old value is still being applied. Why is Workflows not applying the updated value?
All Contact information will be cached or stored for three (3) minutes once the Workflow is triggered to allow for faster data access. If a Contact Field is being updated manually or programmatically while the Contact is still in a Workflow journey, the information will take up to three (3) minutes to be reflected in the Workflow. Until then, the previous value will be shown.
Why is the reply from the Contact not being saved in the Contact Field that I have selected?
It could be because the Contact Field chosen under the Save Response setting does not match the Question Type. Please make sure you select the correct Contact Field for the Question Type when saving a response. For instance, if the Question Type is a date, then the response cannot be saved as a different Contact Field, such as an email address or phone number.
Why am I encountering the "Workflow loop detected" error when trying to publish my Workflow?
The "Workflow loop detected" error occurs when a workflow includes a step that can trigger itself or another workflow that in turn triggers the original workflow, resulting in an infinite loop. Prevent this error from occurring and ensure that your workflow functions as intended by checking your workflow with these steps:
Duplicate triggers in a workflow: Check if any steps in your workflow are identical to the workflow trigger. If the workflow trigger and any step in the workflow are the same, it can cause a loop to occur. Ensure that the workflow trigger is unique and does not match any other steps in the workflow.
Steps that can trigger other workflows: Check if your workflow has any steps that can trigger another workflow. For example, if workflow A has a step that can trigger workflow B, and workflow B also has a step that can trigger workflow A, a loop can occur. Ensure that workflows do not contain any steps that can trigger each other.
