Documentation Index

Fetch the complete documentation index at: https://help.dialpad.com/llms.txt

Use this file to discover all available pages before exploring further.

Workflow Steps - Shared

Prev Next

Dialpad’s shared workflow steps provide personalized conversation flows, efficiently routing callers to the appropriate information and contacts.

Let’s take a look at the shared workflow steps available in Dialpad.

Who can use this

Shared workflows are available to Dialpad Users on all plans and licenses.

Office and Company Admins can create Workflows for Offices, Mainline numbers, Departments, and Contact Centers.

Step types

Customize your conversation experience with Dialpad’s shared workflow steps. They include these logic steps:

Logic

Logic steps make decisions in the workflow based on user input or data. The steps included in Logic are:

  • Go-to: Moves the user to another Workflow or step inside the current workflow.

  • Assign: Creates or updates variables to store information during the session, allowing for greater personalization. If the variable does not exist, the variable will be created and assigned the given value.

  • Branch: Evaluates a variable (system or workflow specific) for a condition and proceeds down a different path based on the result.

  • Customer Data: Capture and surface key customer context to agents for faster, more personalized service.

  • External API: Connect to external data sources to fetch real-time data and drive dynamic routing.

  • Expert: Performs API calls, logic decisions, variables, and other advanced operations.

    Note

    While you can use Expert to perform API calls, it is recommended to use the External API step.

    Expert flows must be enabled by our Professional Services team. Please contact your Customer Success Manager for more information.

Go-To

The Go-to step moves the user to another part of your Workflow, reducing duplication by avoiding multiple path creation. For example, if you have a transfer option that transfers users to your Sales department, use a Go-to step to reach that configuration from multiple parts of the Workflow. This simplifies editing common functions and creates a common path for common steps. If the destination is an Workflow and there is no terminal step in the path, the execution will resume with the step following the Go-to step.

To add a Go-to step:

  1. Open the desired workflow and select ‘+’ to add a new step to your workflow

    Interface showing a shared connection option with a plus icon for adding connections.

  2. Under Logic, select Go-to

    Flowchart illustrating logic steps for digital interactions and data handling processes.

  3. Name the Go-to step

    Note

    The name must be unique across your workflow and is a required field.

  4. Select your destination, options include:

    • Workflow - Select one of your existing Workflows.

    • Step - Select one of your existing steps in the current Workflow.

  5. Select Add

Use the+ function from the workflow editor to add a step after the Go-to step. This step will execute if the Go-to step returns from processing.

Option to add a step after adding a Go-to step.

Note

Be careful to avoid looping! If you call a step that will repeatedly reach a Go-to step, you’ll create a loop. If detected, loops will stop processing and terminate the session, creating a frustrating experience for your users.

Assign

The Assign step creates or updates variables to store information during the session, allowing for greater personalization.

Use the Assign step to:

  • Set a value to use later in the workflow.

    • For example, use the ‘agent.skill variable’ when searching for an agent to route to.

  • Save the value of an existing session variable

  • Save and set values that can be used for API calls in Expert Workflows.

To add an Assign step :

  1. Open the desired workflow and select ‘+’ to add a new step to your workflow

    Interface showing a shared connection option with a plus icon for adding connections.

  2. Under Logic, select Assign

    Flowchart illustrating logic steps for digital interactions and data handling processes.

  3. Name the Assign step

  4. Enter a variable name

    Note

    You can use a new name or select an existing variable from the dropdown.

  5. Enter the value or expression
    Details for an Assign step in a workflow.

    Note

    You can use a variable name as the source of the Assign, or select one of the existing variables from the dropdown. New variables must be alphanumeric characters with no spaces or _ characters (if the variable already exists, the current value will be overwritten).

  6. Select + Add new assignment if you want to add another assignment, or select Save

  7. Select Add

Tip

Be sure to read this Help Center article for more details on variables.

Branch

The Branch Step evaluates system variables and performs specific actions based on the examined value.

Some examples of ways to use Branches include:

  • Check a specific customer's email address using the {{custemail}} variable to perform actions based on it.

  • Check an inbound email using the subject variable to route it to the appropriate workflow.

To add a Branch step:

  1. Open the desired workflow and select ‘+’ to add a new step to your workflow

    Interface showing a shared connection option with a plus icon for adding connections.

  2. Under Logic, select Branch

    Flowchart illustrating logic steps for digital interactions and data handling processes.

  3. Name the Branch step

  4. Select a variable to be evaluated

    • You can choose from the system variables in the drop-down menu, or you can type your custom variable into the edit box.

      Branch step details.

  5. Select Add

Once the Branch step has been created, you will have an empty conditional leg with an optional no-match path.

Branch with two option, and one is a no match path.

Select the Edit icon to edit the condition — this will be the text or regular expression used to match against your variable value.

For example, if you have a specific email channel dealing with billing inquires, branch the customer email based on request type. If the customer asks about renewals, add a variable for subject headings labelled "renewals" (e.g., subject:$renewal^) in one branch. In the other branch, you can add the same variable but for subjects labelled “billing issues” (e.g., subject:$billingissue^).

Select the check mark to confirm the condition and save it to the leg.

Add additional steps using the + button below the condition.

  • Add below the “No Match” leg for items that do not match any condition.

  • If you want to add more conditional legs, click the + below the Branch node.

Branch step with various branch options to add a step based on the conditions.

To delete a conditional leg, hover over the condition and select the Trash can.

Characters Used in Expression Patterns

These characters are used in expression patterns to help find data.

Character(s)

Description

Exact Characters

You can match strings by strictly using basic characters.

Dot (.)

Matches any character except newline.

Caret (^)

The caret (^) is used to match the start of a string.

Dollar sign ($)

The dollar sign ($) is used to match the end of the string.

Asterisk (*)

The asterisk (*) matches zero or more times.

Plus (+)

The plus sign (+) matches one or more times.

(.*)

Matches any single character except for new line, and the string can have empty characters.

\d

Matches any digit in the string.

\w

Matches any word in the string.

Group Patterns ()

Group patterns together to form a full pattern.

Pipe (|)

Used as “OR” to match one or more patterns.

Expression Examples

Tips

It is recommended to use ^ to mark the start of any string (words or numbers) and use a $ to mark the end of the string.

The evaluation of variables can be a static string value, or you can use more powerful regular expressions like the ones listed above.

Customer Data

The Customer Data step simplifies the process of collecting and sharing key customer details that agents and supervisors can view during a session. This enables faster responses, more personalized conversations, and eliminates the need to repeat questions. To set it up, admins define key-value pairs within the workflow step to capture and pass along important customer information.

To add a Customer Data step:

  1. Open the desired workflow and select ‘+’ to add a new step to your workflow

    Interface showing a shared connection option with a plus icon for adding connections.

  2. Under Logic, select Customer Data

    Flowchart illustrating logic steps for digital interactions and data handling processes.

  3. Name the customer data step

  4. Define the Value (variable) for each key:

    System Variables

    Select from a list of pre-defined Dialpad variables such as Customer Name, Customer Email, Company Name, etc. These variables dynamically insert information related to the current session.

    Variables from other nodes

    If you have previously used other nodes (like the "Collect" node to capture digits or speech) and assigned the collected information to a variable, these variables will be available for selection in a list after the system variables.

    Manually entered variables

    For other existing pre-defined variables not shown in the list, you can manually type the variable name enclosed in double curly braces (e.g., {{my_custom_variable}}).

    Static Values

    Enter a fixed text value directly (e.g., "Sales Inquiry", "Support Queue 1").

    Combination of text and variables

    Combine static text with variables to create a descriptive value (e.g., "Caller selected: {{MenuChoice}}").

    Details for customer data steps.

    Note

    You can add up to 10 variables per Customer Data Step.

  5. Select Add

    Tip

    When using multiple values, drag and drop them into the desired order.

Once you’ve created a Customer Data step, go to your Office Settings and enable customer context on calls.

To enable customer context on calls, go to your Dialpad Admin Settings.

  1. Select Office Settings

  2. Navigate to Customer Context on Calls

  3. Select the Enable customer context on calls checkbox

Viewing Customer Data

Here’s what agents and supervisors see when customer context is turned on for calls.

  • Incoming call notification

  • Customer profile and call summary

  • Hold queue

The first three values will be displayed in the incoming call notification, and you’ll see all values in the customer profile and the call summary.

When a call is in the hold queue, you’ll only see the first value.

Notes

This step is designed to use values for already-defined variables (including system variables or those from previous nodes). It's important to note that new variables cannot be created during this step; they must exist beforehand.

Customer information set by the Customer Data step does not display within the Salesforce CTI.

External API

The External API step allows you to fetch data from a separate platform (such as a CRM) via REST APIs. This is useful for retrieving information, such as a customer account or a shipping order.

Note

Make sure the API is accessible via the public internet.

To add an External API step:

  1. Open the desired workflow and select ‘+’ to add a new step to your workflow

    Interface showing a shared connection option with a plus icon for adding connections.

  2. Under Logic, select External API

    Flowchart illustrating logic steps for digital interactions and data handling processes.

  3. Name the External API step

  4. Enter the URL to make the request to the external REST API

    • Example: https://example.com/api/users

      Note

      Ensure that https:// is included in the URL.

  5. Add any URL parameters to the URL API call

    • Example: ?email={{customer.businessid.email}}

  6. Choose the method the API will use for the operation:

    • GET

    • POST

    • PUT

    • PATCH

    External API details.

  7. Add any additional headers to the API

    • Example:

      • Authorization: Bearer {{accessToken}}

      • Accept: application/json

  8. Enter any optional Body or POST JSON data to the API

    • Example:

      • {

         "name": "{{userName}}",

         "age": "{{userAge|type=jsonnumber}}",

         "isActive": "{{isUserActive|type=jsonboolean}}",

         "address": "{{userAddress|type=json}}",

         "phone": "{{userPhone|type=json}}"

        }

  9. Select any variable assignments

    • Examples:

      • Name

      • isActive

      • address.zip

        Note

        Variables can be URL encoded or transposed to JSON using the following formatting on the variable:

        • JSON: {{exampleVariableName|type=json}}

        • URL Encoded: {{exampleURLString|type=urlqueryvalue}}

        • Number in JSON Body value: "{{num|type=jsonnumber}}"

        • Boolean in JSON Body value: "bool":"{{bool|type=jsonboolean}}"

        These examples above are used in expert mode, but highlight how you can use variables in the standard External API step.

    External API step details.

  10. Select Add

Note

For more complex workflows that use APIs, use the Expert Step and configure the API within an Expert Workflow.

Note

Most APIs take only a few seconds to process and can be used with the standard External API step. For APIs that require longer processing times, it’s recommended to use an Expert Workflow.

Expert

Expert steps must be configured by our Professional Services team. Please contact your Customer Success Manager to get started.

To learn more about Expert Workflows, check out this Help Center article.