Guides

External Load Board Integration Guide

Overview

The External Load Board integration allows outside vendors (third-party load board systems) to programmatically post, repost, and remove loads on behalf of a broker organization using the BrokerTMS Public API. This enables external load board platforms to act as a posting layer while keeping shipment data authoritative inside TMS.

Prerequisites

Before configuring this integration, ensure the following are in place:

  • Access to the LSP or Rates drop-down in the TMS back-office
  • Permission to create and manage Integration Sources
  • Your vendor's endpoint URL for receiving outbound webhook events (if consuming Tai webhooks)
  • An active API key / bearer token for the BrokerTMS Public API (v2)

Setup

Step 1 — Create an Integration Source

The integration begins with creating a new Integration Source of type External Load Board.

  1. Navigate to either:
    • LSP → Integration Sources, or
    • Rates → Integration Sources
  2. Click Add New Integration Source
  3. Select External Load Board as the source type
  4. Fill in the Source Information fields:
FieldDescription
Source NameThe display name shown on the Truckload Volume Quoting page. Choose a name that clearly identifies the external vendor (e.g., "My Loadboard Vendor").

Tip: The Source Name is customer-visible — it appears in the Truckload Quoting page alongside other load board integrations, so use a name end-users will recognize.

  1. Save the Integration Source. Note the Integration Source ID — you will need this value for all API calls.

Step 2 — Link the Integration Source to Your Organization

After saving, associate the new Integration Source with the organization(s) that should have access to this load board posting channel. This is done within the Integration Source profile under the Linked Organizations section.

How the Flow Works

External Vendor System
        │
        │  (1) TMS posts/removes via webhook → Vendor receives event
        │
        ▼
  Vendor processes event
  (posts to their load board network)
        │
        │  (2) Vendor confirms posting with a reference number
        │
        ▼
  PUT /PublicApi/Loadboard/v2/UpdateFromLoadboard
  (Vendor writes the loadboard reference number back to TMS)
  1. TMS triggers the vendor — When a dispatcher posts or removes a load from the Truckload Volume Quoting page, TMS sends an outbound webhook payload to the vendor's configured endpoint.
  2. Vendor posts to their network — The vendor's system processes the event and posts the shipment to their load board(s).
  3. Vendor writes back a reference number — Once the vendor's load board assigns a posting ID / reference number, the vendor calls the TMS Public API to store that reference number against the shipment.

API Reference

Authentication

All requests to the BrokerTMS Public API must include a valid bearer token in the Authorization header:

Authorization: Bearer <your-api-token>

PUT /PublicApi/Loadboard/v2/UpdateFromLoadboard

Update Loadboard Posting — Store the External Reference Number

Assigns a reference number (the vendor's posting ID) to a specific load board posting record, identified by the Shipment ID and Integration Source ID.

Endpoint:

PUT https://<your-tms-domain>/PublicApi/Loadboard/v2/UpdateFromLoadboard

Request Body (application/json):

{
  "integrationSourceId": 42,
  "shipmentId": 10001,
  "referenceNumber": "LB-REF-98765"
}
FieldTypeRequiredDescription
integrationSourceIdinteger✅The ID of the External Load Board Integration Source created in Step 1
shipmentIdinteger✅The TMS internal shipment ID to associate the reference number with
referenceNumberstring✅The reference/posting ID returned by the external load board system

Supported Content Types:

  • application/json
  • text/json
  • application/x-www-form-urlencoded
  • application/bson

Responses:

StatusMeaning
200 OKReference number successfully stored against the posting
400 Bad RequestInvalid or missing parameters

Example (cURL):

curl -X PUT "https://<your-tms-domain>/PublicApi/Loadboard/v2/UpdateFromLoadboard" \
  -H "Authorization: Bearer <your-api-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "integrationSourceId": 42,
    "shipmentId": 10001,
    "referenceNumber": "LB-REF-98765"
  }'

Where This Appears in the TMS UI

Once set up, the External Load Board integration is surfaced to back-office users in the Truckload Volume Quoting page:

  • Navigation: Shipments → Truckload Volume Quoting or Shipment Tools → Truckload Volume Quoting
  • The integration appears in the Load Board section (bottom right of the quoting page) under the Source Name you configured
  • Dispatchers can post, repost, or remove loads from within this view — triggering outbound events to the vendor

Related Articles