Article Quick Links
- Connecting the Convey Block
- Configuring the Convey Block
- Using the Convey Block
- Displaying shipping information
Convey is a delivery management service. The Convey Block connects Ada to Convey’s parcel tracking API so that your bot can update your chatters with their package’s tracking information.
Connecting the Convey Block
Before you start, be sure that your ACX Consultant has activated the Convey block for your bot. You’ll also need the API key for your Convey API.
Configuring the Convey Block
- Go to Settings, then Integrations.
- Find Convey under Actions Integrations, then click Configure. The API Key field displays.
- Add your Convey API key to the API Key field.
- Click Save.
Your Convey Block is now ready to use for tracking your chatter’s packages.
Using the Convey Block
Add the Convey Block to an Answer as you would any other block. From there, you simply select an action. Each action in the Convey Block unlocks a specific group of settings fields that allow you to configure the block based on the action you want to perform.
Note: You'll need your chatter's order number to look up an order status with the Convey Block. Use the Capture Block to capture the order number from your chatters before they reach the Convey Block.
- Drag and drop the Convey Block from the block drawer into the Answer workspace.
- Click the Select Action drop-down menu and select Get Shipment Details by Order Number to reveal the configuration options.
- Click the Order Number field to reveal the list of available variables, then select the variable used to capture your chatter's order number.
Order Number Add an order number variable. The Convey Block uses this number to look up the chatter's order status.
Select one or more of the following shipping details to capture, then assign them a variable:
- Carrier SCAC
- Local Date-Time of Status
- Number of Shipments
- Promised Delivery Date
- Shipment Status
- Status Description
- Click the Fallback Answer drop-down and select an Answer from the Answer list.
- Click Save.
The Convey Block is now configured to retrieve the shipping information you’ve chosen.
Displaying shipping information
When the Convey Block is triggered in your Answer, the variables you’ve set to receive the shipping information can be used to relay that information to the chatter. The simplest way is to use a Text Block.
Example of shipping information setup in a Text Block on the Ada Dashboard:
What the chatter sees in the chat:
Have any questions? Contact your Ada team—or email us at firstname.lastname@example.org.