Highway

This article covers how to integrate Highway with your TMS, including token generation, URL setup, recurring sync jobs, Load Lock configuration, data overwrite rules, and fraud prevention features to streamline and secure carrier onboarding.

Highway is Carrier Identity. Focused on solving the digital identity problem in the trucking industry. They Remove risk and friction between brokers and carriers by being the only onboarding provider with a Carrier Identity Engine. They manage carrier identity and solve the problem of fraud and double brokering while providing brokers with the richest data on carrier equipment to supercharge their capacity sourcing and vetting efforts. Highway accelerates connections and drives engagement, making the industry more integrated, digital, and secure.

Table of Content

• Setting Up the Integration

• Carrier Data Updates via Webhooks

• Tai/Highway Carrier Status Logic

• Load Lock Functionality

• Overwrite Setting
  

Setting Up the Integration (Step-by-Step)

To complete the Highway integration, follow the steps below. This will generate your Token, build your links, and configure your settings properly.

1. Generate a Token

1. Go to https://www.guidgenerator.com

2. Click “Generate some GUIDs!”

3. Copy the full Token (it will look like a long string of letters and numbers)

2. Create Your Highway URLs

Use the Token you generated to fill in the two URLs below:

• Onboarding Packets:
  https://www.taicloud.net/publicapi/highway/onboardingpacket/{Token}

• Carrier Alerts:
  https://www.taicloud.net/publicapi/highway/carrieralerts/{Token}

3. Send Both URLs to Highway

Once the URLs are filled in with your Token, send both links to the following email implementations@highway.com

4. Add the Token to the Integration Source

1. For new integrations, continue with the integration setup and include the token in the settings outlined below.
   

   1. If there is an existing Highway integration, access the Integration Source > Edit Source

2. Add a new setting:

   • Name: Token

   • Value: (Paste the Token from Step 1)

5. Clean Up Old Settings

Remove the following settings if they exist, but only after receiving confirmation from the Highway team:

• CarrierJobId

• BulkUploadJobId

• EnableBulkUpload

After cleanup, only the following settings should remain:

• Token (newly added)

• ApiKey (existing)

Setting Up Highway Load Lock

To integrate Highway Load Lock, follow these steps after receiving the setup file from Highway.

1. Get the Setup File from Highway
   Highway will send you a file that includes the following details:
   1. Company (the broker name)

   2. Tai User ID (not needed for the setup)

   3. Webhook_URL

   4. Webhook_api_key

2. Create a Source Setting in the TMS
   Go to Source Settings and create a new source using the details provided.
   1. Source Type:Public API Webhooks
   2. Source Description: Highway Load Lock – [Broker's Name]
      (Replace [Broker's Name] with the name in the file)

1. 1. Username:
      highway
   2. Password:
      Use the Webhook_api_key provided in the file
2. Add Source Settings
   Add the following two settings with the Webhook_URL from the file as the value:
   1. ShipmentCreateUrl
   2. ShipmentDetailUpdateUrl
3. Enable API Tracking
   1. Make sure to enable API tracking for the source.
4. Add the Organization Link
   1. Link the source to the broker’s organization.

Carrier Data Updates via Webhooks

The TMS receives carrier data updates in real time through Webhooks. Whenever Highway detects an update to a carrier’s information, a Webhook triggers automatically and pushes the new details into the TMS. This ensures that broker-facing carrier data is always accurate and up to date.

Imported Carrier Details

The Webhook provides complete carrier profile information, including:

• Carrier Packet

• Insurance

• Payment Terms

• Payment Method

• Factoring Organizations

• Preferred Regions

• Shipment Types

• Equipment Types

• Tax ID

• Remit to Address

• Contacts

• Carrier Alerts

Carrier Alerts

When Highway identifies a significant carrier-related event (such as a change in insurance or any condition that may impact a broker’s carrier compliance rules), it generates a Carrier Alert. The TMS consumes this alert immediately through the Webhook, ensuring brokers always have the most current carrier status available.

Carrier Full Update and Bulk Upload

These jobs run every Saturday to catch up on potential changes on either Highway or Tai. With the Carrier full update, we attempt to get complete carrier data from Highway, and with the Bulk upload, we send complete carrier data from the TMS to Highway.

Single Carrier Sync

The sync is triggered on carrier creation to ensure it is updated in real time.

We will send the following information on the sync:

• Broker carrier ID
• DOT #
• MC #

Tai/Highway Carrier Status Logic

The Tai / Highway Carrier Status Logic defines how carrier statuses provided by Highway map into the Transportation Management System (TMS). This logic ensures that brokers always work with carriers whose compliance and onboarding requirements align with their business rules.

When carrier information is received from Highway, the carrier’s Highway Connection Status is mapped to the appropriate broker carrier status in the TMS, based on the logic below.

Rules Assessment

The system checks the carrier’s rules assessment status, which can be Pass or Fail.

• If the assessment is Pass, the carrier status in the TMS is mapped according to the logic shown in the table above.

• If the assessment is Fail, the carrier status in the TMS is updated to reflect the correct restricted state based on the mapping.

Rules are evaluated whenever Highway provides updated carrier information, ensuring the TMS always reflects the most accurate compliance status for every carrier.

• Carrier Full Update (Saturday job)
• Onboarding Packet
• Carrier Alerts

Load Lock Functionality

The Load Lock feature adds a layer of validation to outgoing emails by leveraging Highway's fraud prevention capabilities. It checks the validity of email addresses and domains to prevent documents from being sent to unverified or potentially fraudulent recipients. This functionality is integrated directly into the TMS and provides users with real-time feedback on email validity.

Key Features

• Email Validation in Send Message Modal
  • Users can opt into validating email addresses via the "Validate Email Addresses" toggle.
• The feature supports:
  • Verification of individual email addresses.
  • Highlighting invalid or suspicious emails and domains in real-time.
  • Providing users with decision-making capabilities to proceed or block.
• Real-Time Feedback
  • Emails are flagged with:
    • Red (Invalid/Unknown): Email or domain is not recognized by Highway.
    • Green (Valid): Email or domain is verified
  • Users receive visual indicators for quick decision-making. 

Email Validation Process

1. Users access the Send Message modal in the TMS.

2. They toggle the "Validate Email Addresses" option.

3. Enter one or multiple email addresses.

4. Add attachments as necessary.

5. Receive color-coded validation results:

   • Red: Indicates issues such as unknown domains or flagged fraud attempts.

   • Green: Confirms validation success.

Overwrite Setting

By default, the system will overwrite attachments (packets), contacts, and insurance information if they are updated in Highway.

If you need the system not to overwrite the information, add a source setting in the integration called Overwrite and make the value equal to false.

When false, the system will add new attachments (packets) if the file name and attachment type differ. Insurance will consider the file name, attachment type, and effective and expiration dates. If these details differ, the system will add a new attachment, leaving the original data in the carrier profile for you to review.

Other fields that the system will not overwrite.

• Contacts

• Payment terms

• Payment method

• Factoring organizations

• Preferred regions

• Shipment types

• Equipment types

• Tax ID

• Remit to address

Factoring Company Sync

During the integration's onboarding process, we will provide the Highway team with a CSV file containing crucial information about the Factoring Companies, including their IDs within the TMS. The Highway team will subsequently map these IDs on their platform as the initial safeguard against any potential duplication of factoring companies.

Furthermore, additional checks will be performed to enhance data integrity and minimize duplication risks, including verification of the physical or bill-to-zip codes and cross-referencing the company names.

Back to Top