Integration options

​

1. Webhook Integration

The webhook approach provides a real-time, push-based method. Your TMS sends immediate event notifications to FleetWorks whenever there are updates, while FleetWorks pushes bid events back to your TMS.

​

How It Works

• Event Push:
  • Load Events: Your TMS sends updates on load changes.
  • Carrier Events: Your TMS pushes carrier-related updates.
• Bid Events Return:
  • FleetWorks notifies your TMS of bid events as soon as they occur via API.

​

Sequence Diagram

​

Benefits

• Real-Time Updates: Immediate synchronization ensures that your system is always current.

If you decide to go with this path, see Load Events Webhook for more details on the shape of the payloads to send to FleetWorks.

---

​

2. Pull-Based Integration

The pull-based integration is an alternative approach where FleetWorks retrieves data from your TMS at regular intervals via API calls.

​

How It Works

• Data Pulling:
  • FleetWorks periodically requests Load data from your TMS.
  • FleetWorks requests Carrier data when necessary.
• Bid Events Return:
  • FleetWorks notifies your TMS of bid events as soon as they occur via API.

​

Sequence Diagram

​

Benefits

• Scheduled Data Retrieval: Ideal for systems that prefer periodic updates over continuous real-time integration.
• Simplicity: Reduces the need for constant webhook configurations for load and carrier data.

If you decide to use the pull-based approach, additional configuration steps are required. See the “Pull-Based Integration Setup” section below.

---

​

Getting Started

Follow these steps to integrate your TMS with FleetWorks:

​

1. Authentication

• Bearer Token:
  • You will receive a bearer token from FleetWorks to authenticate API requests.
  • Include the token in the Authorization header:

    Authorization: Bearer <your-token>
    

​

2. Configuring Integration Based on Your Chosen Approach

​

For Webhook Integration

• Outbound Webhooks:

  • Configure your system to send the following events to FleetWorks:
    • Load Events Webhook
    • Carrier Events Webhook
  • Ensure endpoints are secured with HTTPS and that you validate incoming requests.

• Inbound Webhooks:

  • Prepare your TMS to receive bid events from FleetWorks:
    • Bid Events

​

For Pull-Based Integration

• API Endpoint Setup:

  • Expose Endpoints:
    • Configure your TMS to expose secure API endpoints that return Load and Carrier data.
    • Ensure that these endpoints can handle requests from FleetWorks and return data with the same fields outlined in the Load Events Webhook.
  • Authentication & Security:
    • Use the provided bearer token to authenticate incoming pull requests from FleetWorks.
    • Confirm that your API endpoints are accessible over HTTPS and are properly rate-limited if necessary.

• Bid Events:

  • Despite using pull for load and carrier data, your TMS must still be configured to receive bid events from FleetWorks:
    • Bid Events

​

3. Detailed Endpoint Specifications

• Documentation:
  • Refer to the API Reference section for detailed endpoint specifications, sample payloads, and error handling guidelines for both push and pull-based methods.