Overview

Use webhooks to receive real-time HTTP notifications of changes to specific objects in the Freight Exchange.

Using webhooks means that you will not need to query the API for changes to objects that may or may not have happened and helps you avoid reaching limits. All webhook events are optional, so select those that are most relevant for the experience you are trying to create.

The following types of webhook events are available:

Configuration

To configure webhooks, follow this process:

  1. Email: [email protected] and provide:
    • the customer’s details
    • the full URL that will be used for receiving events
  2. When a load is created by the Create a load method, set callbackRequired: true .

Receiving updates

Every time there are changes, TEG will issue a HTTPS POST to your server endpoint.

You must respond to this request with HTTP code 200.