Skip to main content

Enabling Tai TMS

How to enable the TMS integration in Chain for Tai

Param avatar
Written by Param
Updated over a month ago

How to enable Tai TMS integration in Chain

If you use Tai as your TMS provider, it is easy to enable the integration.

There are two main steps to enabling Tai TMS integration in Chain:

  1. Creating a public key for Chain in Tai - This step enables data from Chain to Tai. For example, this will allow Chain to update locations on a load in Tai

  2. Creating an integration source in Tai - This step enables data from Tai to Chain

  3. Upload Historical Data - We can upload historical load data that powers carrier suggestions in Chain Booking

Step 1

Creating a Public Key for Chain in Tai

Note: You must do this with an Admin Tai Account

In these instructions, we will generate a public API key in Tai for Chain to use when updating pertinent load information (such as arrival/departures and load locations) in Tai.

The steps involve:

  1. Go inside of Tai, click LSP, and then Public Authentication Key

tai tms create public auth key

2. Click the Add Public Authentication Key button

tai tms add new integration source


3. A pop-up should show. Fill in the following details:

  • Organization: Should be automatically selected unless you have multiple organizations

  • Staff: Should be automatically selected, or you can select yourself

Copy the "Authentication Key", we will paste it inside of Chain. Then click "Save"

tai tms create integration source

4. Navigate to the "Settings" page in Chain. (Click your Avatar at the top right)

5. Click on Apps on the left menu

6. Scroll down to the Tai app and click Enable.

7. Paste the Authentication Key you copied from Tai into the Public Key field in Chain

Step 2

Creating an Integration Source in Tai

Note: You must do this with an Admin Tai Account

These instructions set up an integration source inside of Tai which allows the syncing of load information from Tai -> Chain.

The steps involve:

  1. Generate an API Key inside of Chain. See Generating an api key in Chain

    If you would like to set up a sandbox (or beta) environment, please reach out to your Chain account manager so they can also set up a sandbox environment for you where you can generate a Sandbox API Key

  2. Go inside of Tai, click LSP, and then Integration Sources

tai tms integration sources

3. Click "Add New Integration Source"

tai tms add new integration source

4. Create a new integration source with the following details:

  • Source Description: You can type "Chain - " followed by your company name

  • Source Group: Choose Other

  • Integration Type: Choose Public API Webhooks

  • Owner Organization: Should be automatically selected unless you have multiple organizations

DO NOT ADD these fields below. Tai will override the Authorization field in the next step if you do.

  • User Name: leave this blank

  • Password: leave this blank

5. Click "Save and View Details"

6. Now we will add the integration "Source Settings". Click "Edit Source"

7. Fill in the following values for the "Name" and "Value" fields:

  • Authorization - The value for this "Name" is the API Key you generated in Chaie

  • ShipmentCreateUrl

    https://api.chaineapp.com/apps/events/v1/tai
  • ShipmentDetailUpdateUrl

    https://api.chaineapp.com/apps/events/v1/tai
  • ShipmentStatusUpdateUrl

    https://api.chaineapp.com/apps/events/v1/tai
  • LSPCarrierCreateUrl

    https://api.chaineapp.com/apps/events/v1/tai/carriers
  • LSPCarrierUpdateUrl

    https://api.chaineapp.com/apps/events/v1/tai/carriers

ONLY DO THE FOLLOWING IF you are NOT using Chain for tracking. If you are using Chain for tracking, do NOT add ShipmentLocationUpdateUrl.

  • ShipmentLocationUpdateUrl

    https://api.chaineapp.com/v1/events/tracking/tai/location


    Here is how it should look

    tai tms integration source settings

8. Click Save and View Details

9. At the bottom of the page, the Linked Organization needs to be set and will ensure that shipments for that organization are submitted. Select the appropriate org and click Save

If you have multiple orgs that need to map to different workspaces inside of Chain, please work with your Chain Implementation Specialist to ensure that the correct orgs are linked to the correct workspaces. They will be able to help you set this up.

tai tms integration source settings

That's it! Once Tai enables the webhook, loads will begin to flow into Chain.

Generating an API Key in Chain

To generate an API Key in Chain, you will need to have the "Admin" role. If you do not have this role, please reach out to your Chain account manager to have them generate an API Key for you.

Steps:

  1. Navigate to the "Settings" page in Chain. (Click your Avatar at the top right)

  2. Click on 'Apps' on the left-menu

  3. Scroll down to the "Tai" app and click Enable

  4. Click "Create Key" to generate an API Key

  5. Click "Reveal key" to show the key, and then simply click-it to copy the key to your clipboard.

That's it! You now have an API Key that you can provide to Tai to enable the integration.

Step 3

Upload Historical Loads

If you're using Chain Booking and want to upload your historical loads to leverage Chain's Carrier Suggestions, you can upload your historical loads.

The easiest way to handle this is to allow your Chain Implementation Specialist to do this for you by providing them with a temporary Tai login. Alternatively, you can do it yourself by following the instructions below.

Step-by-Step Guide to Export Historical Loads

Creating a Custom Report

  1. Go to Reports

    • Navigate to the "Reports" section in Tai TMS.

  2. Select Manage Custom Reports

    • Click on "Manage Custom Reports" to start creating a new report.

  3. Add New Report

    • Click on "Add New Report."

  4. Name the Report

    • Name the report: Chain - historical loads.

  5. Select a User

    • Select yourself as the user for the report.

  6. Configure Report Columns and Filters

    • Ensure "Shipment" is selected under Available Report Columns.

    • The following columns must be selected along with Filters for Created Date & Time, Shipment Type, and Status:

      • Created Date & Time*

      • From the "Commodity Information" section:

        • Total Weight

        • Commodity Descriptions

        • Commodity Marks

      • From the "Customer Information" section:

        • Customer Name

      • From the "Destination Location" section:

        • Destination City

        • Destination State

        • Destination ZIP Code

        • Destination Stop Type

      • From the "Linehaul Carrier Information" section:

        • Linehaul Carrier Name

        • Linehaul Carrier Phone

        • Linehaul Carrier SCAC

        • Linehaul Carrier DOT Number

        • Linehaul Carrier MC Number

        • Linehaul LSP Carrier Email

      • From the "Origin Location" section:

        • Origin City

        • Origin State

        • Origin ZIP Code

        • Origin Stop Type

      • From the "Pricing Detail Information" section:

        • Accessorial List

      • From the "Reference Numbers" section:

        • Temperature

        • Carrier Dispatcher Name

        • Carrier Dispatcher Phone Number

        • Carrier Rep

        • Carrier Rep Id

      • From the "Sales Rep Information" section:

        • Sales Rep Name

        • Sales Rep Ids

        • Sales Rep Email

      • From the "Shipment Dates" section:

        • Pickup Date

        • Delivery Estimated Date

        • Delivery Estimated Date & Time

        • Created Date & Time*

        • Pickup Appointment Start Date & Time

        • Pickup Appointment End Time

      • From the "Shipment Information" section:

        • Shipment ID

        • Shipment Type

        • Service Level

        • Status

        • Mileage

        • Trailer Size

        • Trailer Type

        • Accessorial List

        • Carrier Name List

      • From the "Shipment Pricing Information" section:

        • Sell Total

        • Buy Total

        • Margin Total

  7. Make sure the following filters are selected on the right-side table for the following fields:

    • Created Date & Time - Filter: Last 12 Months

    • Shipment Type - Filter: Contains "Truckload, DomesticFreight"

    • Status - Filter: Contains "[ "Delivered" ]"

Setting Up the Delivery Schedule

  1. Select Delivery Schedule

    • After configuring the report columns and filters, select the "delivery schedule."

  2. Add Delivery Schedule

    • Click on "Add Delivery Schedule."

  3. Configure the Delivery Schedule

  • Set the following options:

    • Frequency: Weekly

    • Deliver On: Select today's day

    • Time of Day: Select 30 minutes from the current time

    • Export Format: JSON

    • Status: Active

    • Recipient Emails: dev-support@chaineapp.com

    • Subject: Your company's name followed by "Historical File Upload"

    • Body: Leave it empty or enter the same as the Subject

Final Steps

  1. Remove Delivery Schedule

    • By the end of the day (usually after 30-60 minutes from the "Time of Day" you selected), go back to the Custom Report and remove the delivery schedule to stop further exports.

Following these steps will enable you to export historical loads from Tai TMS efficiently. If you encounter any issues or need further assistance, don't hesitate to reach out to your Chain Implementation Specialist.

Did this answer your question?