This is a tutorial series that's cumulative in nature. To start from the beginning, start here.

Many use cases require integration with an API to send and receive data. In this tutorial you add an integration to check a user’s order status.

This tutorial uses an example API that returns random order status info when given an order number.

Step 8: Create the Order Status dialog

The Cross-vertical domain that you created in the previous tutorial contains a “check order status” intent that you will use in Conversation Builder to trigger a new dialog.

  1. Open your Getting Started bot in Conversation Builder.
  2. Create a new regular dialog (type = Dialog) named “Order Status.”

    By default, a regular dialog includes a Dialog Starter interaction, but it isn't configured yet. You'll use the Assist tool to do this.

  3. Click Assist icon (Assist icon) beside the interaction to open the Assist tool.

    Select the “LP_Cross-vertical” domain, followed by the "check order status" intent. You can locate this intent either by scrolling through the list of intents, or by searching with a phrase such as, "I want to check the status of my order." Selecting this intent associates it with the dialog starter.

    Associating the check order status intent with the dialog starter in the Order Status dialog

  4. Add a new Text Statement to acknowledge the user's intent. Add the text, "Let’s find your order."

  5. Add a new Text Question to capture the user’s order number. Add the text, "What's your order number?"

  6. Still in the Text question, add a custom rule that checks whether the order number is valid:

    Select the Next Action dropdown, and click + Custom Rule within it. In the Add Next Action Rule window, name the rule "Order number". Then click + Add Condition. For the condition, select "Regular Expression" from the list of match types, and add the following regular expression (regex) to match the order number format (a letter followed by six digits): ^\w\d{6}$

    This mock API will successfully return order data for accounts A001001, A001010 and A001002.

    Still in the rule, capture the user’s order number as a variable: Click + Add Variable. Name the variable orderNumber, and enter {$userMessage} for its value.

    Adding a rule to capture the user's order number

    {$userMessage} is just one of many system variables you can use in your interactions.

    Click Save.

    By saving the result of the user’s response as the variable orderNumber, we will have access to that data throughout the bot. In this case, we will use that within our API call to find the user’s order.

Step 9: Create an Order Status API integration

  1. In the upper-left corner, click Integrations on the menu bar.
  2. On the Add Integration page, configure the integration as follows:
    • Integration Name: OrderStatus
    • Response Data Variable Name: OrderStatus
    • Integration Type: API
    • Method: GET
    • URL:{$botContext.orderNumber}

      Note the use of the orderNumber bot variable being interpolated onto the end of the URL string.

    • Custom Data Fields: These provide a simple method of displaying the results in interactions in dialogs. The return data is stored here. (For more on processing API results with custom data fields, see this section.)
    Key Value
    id {$}
    name {$}
    orderStatus {$.api_OrderStatus.orderStatus}
    image {$.api_OrderStatus.image}

    The Integration Settings window

  3. Click Save.

Step 10: Use the integration in a dialog

  1. In the upper-left corner, click Dialogs on the menu bar, and return to the Order Status dialog.
  2. Following the text question where we’ve captured the user's order number, create a new Integration interaction.

    From the dropdown, select your newly created OrderStatus API Integration.

    The Integration interaction added to the dialog

  3. To display our returned API data, add a new Structured question interaction.

    In the Structured Question title section, add {}.

    When the Integration interaction runs, it stores the response data in the custom data fields that you configured in the integration. is the Response Data Variable Name followed by the name of that custom data field, which is “name.” (For a quick reference on using variables in interactions, see this section.)

    For the subtitle, add {OrderStatus.orderStatus}.

    The partially configured Structured question interaction

    Click “ADD IMAGE” and in the Image URL field, add {OrderStatus.image}.

    The configured Structured question interaction

    While images show properly in Preview, deployed bots need to have the image domains whitelisted. Contact your LivePerson representative or LivePerson Support for assistance.

    Now let's test all this out.

  4. Open the Preview window, and start a new session by clicking Reset Session.

  5. Trigger the Order Status dialog by entering "What is my order status" or something else that will match our Order Status intent.

  6. Following the prompt for an order number, type A001001 as your order number, and press Enter.

  7. Verify that you are successfully receiving order information that is displayed with a user’s name, order status, and image.

    Previewing the conversation

    Congratulations! You now understand the basics of integrations and variables.

What's next?

Continue on to the next tutorial in the series.