Workflows Overview

Getting Here

You can access this module by selecting Workflows from the side navigation menu.

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.

Workflows Module

The main page of the Workflows Module is a listing page. It provides an overview of the Workflows in your Workspace.

Below are the actions that can be performed in Workflows:

• ​Creating a New Workflow​
• Creating a New Workflow from a Selected Template
• ​Saving a Workflow​
• Testing a Workflow
• ​Publishing a Workflow​
• ​Stopping a Workflow
• Stopping a Workflow for a Contact​
• ​Editing a Workflow​
• Cloning a Workflow
• Deleting a Workflow
• Exporting a Workflow
• Importing a Workflow

Creating a New Workflow

To create a Workflow:

1. Navigate to the Workflows main page.
2. Click + Add Workflow.
3. Name the Workflow.
4. Click Create. The Workflow Builder will be displayed.
5. Start building the Workflow by selecting a Trigger. You can then add steps along with the necessary configurations or conditions.
6. Once completed, click Save. The Workflow created will be in Draft status.

Creating a New Workflow from a Selected Template

Create a Workflow from the list of templates:

1. Navigate to the Workflows main page.
2. Click the + Add Workflow button.
3. Click Use Template on the preferred template.
4. Click the Use Template button. The pre-built Workflow will be created. Update the steps highlighted in red.
5. Once completed, click Save. The Workflow created will be in Draft status.

List of Workflow Templates

Saving a Workflow

A Workflow can be saved by clicking the Save button in the Top Bar of the Workflow Builder.

Resolving Workflow Errors

If a Step in the Workflow is configured incorrectly, the ⚠ sign will appear in the Top Bar. Hover over the icon to see which Steps have configuration errors. Click on the Step in the dropdown list to identify it in the Workflow builder and open its settings in the configuration drawer.

Testing a Workflow

You can test your workflow before publishing it by clicking the Test button in the Top Bar of the Workflow Builder. This button is enabled once you have resolved any errors in your workflow.

1. On the Test Workflow dialog, select a channel from the Channel dropdown list to test your workflow.
2. If your workflow trigger (e.g. Conversation Opened) has trigger variables, the Trigger Variable (optional) dropdown displays on the dialog. You can select the required dummy values for testing. You can also leave the fields empty; they will be considered null and the workflow will be tested using null values.
   The dummy values for workflow triggers you provide while testing the workflow do not apply to the workflow once it's published. Once published, the date and time defined in the Date & Time Step will be used for validation. Learn more about Workflow Trigger Variables here.

1. Click Next.

1. On the Test Workflow dialog, the QR code and chat link for the selected channel are displayed. Scan the QR code using a mobile device or click the link to open the chat in your browser.
2. Send the code (e.g. TEST1234) on the opened channel to trigger the workflow for testing.
   You can send the code as many times as you need to trigger the workflow so you can test it. The code cannot be used once the End Testing button is clicked.
3. Click End Testing to close the Test Workflow dialog when you are done testing.

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

The Workflow will run once it is published. Contacts who meet the trigger criteria will enter the Workflow. To edit a published Workflow, you need to first stop the Workflow.

Stopping a Workflow

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 can be edited.

Stopping Workflow(s) for a Contact

You can stop the desired workflows one by one or all workflows for the Contact in one go:

Inbox Module

Navigate to the Workflows icon, in the Ongoing Workflows tab, click Stop on the desired Workflow or select Stop all to stop all the workflows.

Workflows Module

Access the Workflow Settings from the Action menu in the Workflow overview page or within the Workflow builder by clicking the settings icon and toggle on Allow users to stop this Workflow for a Contact.

Editing a Workflow

You can edit a Workflow by clicking the Actions menu on the Workflows listing page, and then clicking Open in Builder. You can edit the Workflow from the Workflow Builder.

Cloning a Workflow

You can create a Workflow by cloning an existing one. Click the Actions menu on the Workflows listing page and click Clone.

When a Workflow is cloned, the trigger and Steps are copied over to the new Workflow. The name of the new Workflow will also follow the name of the original Workflow and appended with clone at the end. You can still make necessary changes before publishing it.

Deleting a Workflow

You can delete a Workflow by clicking the Actions menu on the Workflows listing page and clicking Delete. Click Delete again on the pop up message to confirm the deletion.

Exporting a Workflow

You can export a Workflow by clicking the Actions menu on the Workflows listing page, and then clicking Export Workflow.

The Workflow will be downloaded as a JSON file.

It can then be imported to another Workspace or Organization.

Importing a Workflow

You can import a Workflow by clicking the dropdown arrow beside the + Add Workflow button on the Workflows listing page, and then clicking Import Workflow.

Click Browse file to select your Workflow and click the Import button.

To import your Workflow successfully, please make sure:

• The file is in a JSON format and was created on the respond.io platform
• All the values in the JSON file are correctly listed and formatted
• The file cannot exceed 400 KB
• The file cannot contain more than 100 Workflow steps

Imported Workflows inherit the name and description from the import file. If the name already exists, the name of the imported Workflow will be appended with a number starting at (2) and increase by 1 for duplicates.

E.g. Welcome Message (2), Welcome Message (3), Welcome Message (4).

Workflows Module Listing

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.

Actions Menu

The last column in the Workflows row contains the Actions Menu. The following actions can be performed here:

The Workflow Builder

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 Tool​s
• ​Canvas​
• ​Configuration Drawer​

The Top Bar

The top bar is used to manage key Workflow items like its name, description, errors in step configuration and status. The elements of the top bar are as below.

Workflow Settings

Allow users to stop Workflow for Contact

• Toggle on to allow users to stop Workflow for Contact immediately at any point from the Inbox module. You can enable this setting without stopping the workflow.

Set exit conditions to stop this Workflow for a Contact

• Toggle on to stop Workflow for Contact:
  • When outgoing message is sent
  • When incoming message is received
  • When a user is manually assigned to a Contact
  Ongoing Workflows need to be enabled from Workflow Settings to work. Make sure this option is switched on before using this feature.

Assistive Tools

The five Assistive Tools are designed to help you navigate the Canvas:

• Zoom In
• Zoom Out
• Center
• Undo
• Redo

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

FAQ and Troubleshooting

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:

1. The Workflow was stopped - If a Workflow is stopped, all enrolled Contacts will be immediately ejected from the Workflow.
2. 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.
3. 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.
4. 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​.​
5. 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.
6. 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 email address or phone number.

How do I turn off the Dialogflow Bot?

To turn off Dialogflow Bot, you need to:

1. Add the Update Contact Field Step
2. In the Step configuration, select Bot Status in the Contact Field dropdown list
3. Set the Bot Status value as On/Off as required

Choose this method to turn off your Dialogflow Bot in any of the following cases:

• To automate turning off the bot
• To ensure any replies from customers do not trigger Dialogflow for specific scenarios while the Workflow is running

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:

1. 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.
2. 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.

Why can't I stop a Workflow from the Inbox module?

To stop a Workflow from the Inbox module:

1. Navigate to the Workflows module and to your desired Workflow.
2. Access the Workflow Settings from the Action Menu in the Workflow overview page or within the Workflow builder by clicking the settings icon.
3. Toggle on "Allow users to stop this Workflow for a Contact".

What is the Workflow limitation for the Business plan on respond.io?

For the Business plan, the limitation is a maximum of 100 Workflows per Workspace. To understand more about the features available for each plan, including the Business plan, please visit our detailed comparison page at respond.io Pricing and Features.

Why did I encounter the error "Invalid JSON schema, please submit a valid JSON file" when importing a Workflow?

You will encounter this error in any of the following scenarios:

• if your Workflow contains a trigger but no Step.
• if your Workflow contains multiple triggers, with or without a Step.