> This page is for version Scripted.
> For other versions, use one of these documentation indexes:
> - Generative (default): https://developers.ada.cx/generative/llms.txt
> - Scripted: https://developers.ada.cx/scripted/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.ada.cx/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.ada.cx/_mcp/server.

# Let chatters track shipments using the Convey block

## Overview\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_id_1500011069361_id_h_01F5XCPWKD73VKHR595VW55BHZ]

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.

> **Note**
>
> This feature may not be included with your organization's subscription
> package. For more information, see Ada's
> [Pricing](https://www.ada.cx/pricing) page, or contact your Ada team.

## Prepare your bot\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_section-idm4487416886601633469458097237]

Before using the Convey block in your bot, you should do two things:

1. Set up a [Capture block](/scripted/docs/build-and-maintain-your-bot/work-with-blocks-and-apps/save-chatter-information-using-the-capture-block)
   to capture the order number from your chatters before they reach the
   Convey block. Then, you can easily reference that variable in the
   Convey block.

2. Think about how you want to verify chatters to ensure that the wrong
   people don't access sensitive information or perform sensitive
   actions. For your chatters' security, it's a good idea to verify
   and/or authenticate chatters. For more information, see [Protect chatter data using verification and authentication](/scripted/docs/build-and-maintain-your-bot/personalize-conversations/protect-chatter-data-using-verification-and-authentication).

## Connect the Convey block\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_id_1500011069361_id_h_01F5XCQF667GFX172HP1WKM08E]

Before you start, be sure that your Ada team has activated the Convey
block for your bot. You’ll also need the API key for your Convey API.

## Configure the Convey block\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_id_1500011069361_id_h_01F5XCQSAKV0W3XT36DZSQAMKK]

1. On the Ada dashboard, go to **Settings**, then **Integrations**.

2. Under **Actions Integrations**, find **Convey**, then click
   **Configure** beside it. The API Key field displays.

3. Add your Convey API key to the **API Key** field.

4. Click **Save**.

Your Convey block is now ready to use for tracking your chatter’s
packages.

## Use the Convey block\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_id_1500011069361_id_h_01F5XCRYMY21JW29DP9SC8WFRA]

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.

1. Drag and drop the Convey block from the block drawer into the Answer
   workspace.

2. Click the Select Action drop-down menu and select **Get Shipment
   Details by Order Number** to reveal the configuration options.

3. Click the **Order Number** field to reveal the list of available
   variables, then select the variable used to capture your chatter's
   order number.

   <table>
     <tbody>
       <tr>
         <td>
           **Order Number**
         </td>

         <td>
           Add an order number variable. The Convey block uses this number
           to look up the chatter's order status.
         </td>
       </tr>

       <tr>
         <td>
           **Optional Variables**
         </td>

         <td>
           Select one or more of the following shipping details to capture,
           then assign them a variable:

           * Carrier
           * Carrier SCAC
           * Local Date-Time of Status
           * Number of Shipments
           * Promised Delivery Date
           * Shipment Status
           * Status Description
         </td>
       </tr>
     </tbody>
   </table>

4. Click the **Fallback Answer** drop-down and select an Answer from
   the Answer list.

5. Click **Save**.

The Convey block is now configured to retrieve the shipping information
you’ve chosen.

![](/_fern-files/_img/e3d55595be9cb96e42e58916b7652649581a37e39b5331f2e6b8a3264840b962.webp)

## Display shipping information\[#UUID-35d8e623-873a-0e4d-8964-29ab7063ecc1_id_1500011069361_id_h_01F5YPTDXDEQRXAE24YQQZBJJ6]

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:

![](/_fern-files/_img/32ef7b6e165c2f93964313ae53e07d6a8836346179925f20c1c12d7da691cd09.webp)

What the chatter sees in the chat:

![](/_fern-files/_img/63ecd7a7c053777e3eb815f2099b8c2f4d4dfdba15262d9fc5c3bae9c36c0ce3.webp)

---

Have any questions? Contact your Ada team, or email us at [](<mailto:help@ada.support%20%E2%80%9CHelp Docs inquiry%E2%80%9D>).