Webhooks

Retry Policy

Webhook requests will timeout after 30 seconds. If the Client API does not return a 2xx response in 30 seconds, then the webhook will be considered failed.

• Retry count: 5
• Retry interval: 60 seconds

Events

Event	Description
shipment.created	Occurs when a new shipment is created
shipment.rate_adjustment	Triggered when the final rate is set/adjusted for the shipment
shipment.modified	Occurs every time a shipment is modified in the TMS
shipment.assigned	Shipment has been assigned to a carrier
shipment.picked_up	Shipment has been picked up by the carrier
shipment.delivered	Shipment has been delivered by the carrier
shipment.bol_available	The BOL for the shipment is completed and available
shipment.canceled_by_carrier	Shipment was canceled by the carrier
shipment.canceled	Shipment was canceled by the shipper

shipment.created

Occurs when a new shipment is created

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.created",
  "event_date": "2024-08-10T08:00:00+0000"
}

shipment.rate_adjusted

Triggered when the final rate is set/adjusted for the shipment

The rate adjusted payload has these additional fields:

Field	Type	Description
data.price.old_value	number	the price of the shipment before the change
data.price.new_value	number	the new price of the shipment
data.price.difference	number	the difference of the price change

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.rate_adjusted",
  "event_date": "2024-08-10T08:00:00+0000",
  "data": {
    "price": {
      "old_value": 225,
      "new_value": 250,
      "difference": 25
    }
  }
}

shipment.modified

Occurs every time a shipment is modified in the TMS

The shipment.modified payload has these additional fields:

Field	Type	Description
data.....old_value	string OR null	the original value of the key before the change
data.....new_value	string OR null	the new value of the key

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.modified",
  "event_date": "2024-08-10T08:00:00+0000",
  "data": {
    "customer": {
      "customer_name": {
        "old_value": "Customer",
        "new_value": "Customer, LLC."
      }
    },
    "pickup": {
      "notes": {
        "old_value": null,
        "new_value": "Please call ahead at (XXX) XXX-XXXX"
      }
    }
  }
}

shipment.assigned

Shipment has been assigned to a carrier

The shipment.assigned payload has these additional fields:

Field	Type	Description
data.carrier_name	string	the name of the Carrier company
data.carrier_usdot	string	the USDOT number of the carrier
data.carrier_email	string	the dispatch email for the carrier
data.carrier_phone	string	the dispatch phone for the carrier
data.driver_name	string	the name of the driver being sent in by the carrier
data.driver_phone	string	the phone number for the driver being sent in

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.assigned",
  "event_date": "2024-08-10T08:00:00+0000",
  "data": {
    "carrier_name": "Carrier Company, LLC.",
    "carrier_usdot": "0010001",
    "carrier_email": "carrier@email.com",
    "carrier_phone": "(214) 214-3530",
    "driver_name": "My Driver",
    "driver_phone": "(214) 214-3530"
  }
}

shipment.picked_up

Shipment has been picked up by the carrier

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.picked_up",
  "event_date": "2024-08-10T08:00:00+0000"
}

shipment.delivered

Shipment has been delivered by the carrier

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.delivered",
  "event_date": "2024-08-10T08:00:00+0000"
}

shipment.bol_available

The BOL for the shipment is completed and available

The shipment.bol_available payload has these additional fields:

Field	Type	Description
data.bol_url	string OR null	the URL for the BOL PDF

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.bol_available",
  "event_date": "2024-08-10T08:00:00+0000",
  "data": {
    "bol_url": "https://bol.crestlineautotransport.com/QO1bxqJyvQgOj3MqVdkQNxXPe"
  }
}

shipment.canceled_by_carrier

Shipment was canceled by the carrier

info

This will unassign the carrier and driver from the shipment

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.canceled_by_carrier",
  "event_date": "2024-08-10T08:00:00+0000"
}

shipment.canceled

Shipment was canceled by the shipper

info

This will mark the shipment as canceled and will no longer be an active shipment

{
  "shipment_id": "f210b4f3-c367-466b-81a6-35e0aedbf442",
  "event": "shipment.canceled",
  "event_date": "2024-08-10T08:00:00+0000"
}