Skip to main content
POST
/
api
/
v1
/
webhooks
/
loads
/
events
Load events webhook
curl --request POST \
  --url https://api.fleetworks.ai/api/v1/webhooks/loads/events \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "5678",
  "pickupTime": "2025-04-08T22:00:00",
  "pickupEndTime": "2025-04-08T23:00:00",
  "dropoffTime": "2025-04-12T08:00:00",
  "dropoffEndTime": "2025-04-12T12:00:00",
  "origin": {
    "street": "100 Broadway",
    "city": "NEW YORK",
    "state": "NY",
    "country": "US",
    "zip": "12345",
    "timezone": "America/New_York"
  },
  "destination": {
    "street": "200 Main Street",
    "city": "LOS ANGELES",
    "state": "CA",
    "country": "US",
    "zip": "67890",
    "timezone": "America/Los_Angeles"
  },
  "status": "UNASSIGNED",
  "customerName": "Nike",
  "accountManagerEmail": "account.manager@example.com",
  "stops": [
    {
      "type": "pickup",
      "address": {
        "street": "123 Main Street",
        "city": "Buffalo",
        "state": "NY",
        "country": "US",
        "timezone": "America/New_York",
        "zip": "67890"
      },
      "windowStart": "2024-04-10T07:15:00",
      "windowEnd": null
    },
    {
      "type": "dropoff",
      "address": {
        "street": "456 Commerce Drive",
        "city": "Aurora",
        "state": "CO",
        "country": "US",
        "timezone": "America/Denver",
        "zip": "80010"
      },
      "windowStart": "2024-04-11T17:45:00",
      "windowEnd": null
    }
  ],
  "equipment": "53ft Dry Van",
  "totalDistance": 1120,
  "weight": 42000,
  "commodity": "Electronics",
  "customerRate": 2000,
  "startRate": 1500,
  "maxRate": 2500,
  "bookNowRate": 1500,
  "currency": "USD",
  "specialInstructions": "Driver'\''s assist required. Tracking required.",
  "teamServiceRequired": true,
  "outboundCarrierSalesEnabled": false,
  "routingGuideEnabled": false,
  "isVisibleToExternalCarriers": true,
  "isVisibleToFleetworksCarrierNetwork": true,
  "locked": false,
  "isAutoBookable": true
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

An authentication token that identifies the organization associated with the event. You can reach out to FleetWorks team to request a token.

Body

application/json

The startRate, maxRate, and customerRate, and customerName are what we display in the UI. These help provide context when the broker is calling back a carrier to negotiate.

​
id
string
required

A unique identifier for the load

​
pickupTime
string
required

The local start time for the pickup in the ISO format

​
dropoffTime
string
required

The local start time for the dropoff in the ISO format

​
origin
object
required
​
destination
object
required
​
status
enum<string>
required

Represents the current status of the load:

  • OPPORTUNITY: A potential shipment that the broker is trying to secure from the shipper
  • UNASSIGNED: Broker won the load from the shipper but has not yet been assigned to a carrier
  • TENDERED: Broker has tendered the load to a carrier
  • COVERED: The load is fully covered by a carrier (carrier has accepted)
  • IN_TRANSIT: The load is currently being transported
  • DELIVERED: The load has been successfully delivered
  • ON_HOLD: The load is temporarily on hold and not available for carriers
Available options:
OPPORTUNITY,
UNASSIGNED,
TENDERED,
COVERED,
IN_TRANSIT,
DELIVERED,
ON_HOLD
​
pickupEndTime
string | null

The local end time for the pickup in the ISO format. Send this if pick up time is a window

​
multiPickupDaysCount
number | null

The number of days the pickup is spread out over

​
dropoffEndTime
string | null

The local end time for the dropoff in the ISO format. Send this if dropoff time is a window

​
originSchedulingType
enum<string>

Indicates the facility scheduling type. APPOINTMENT requires a scheduled appointment; FCFS is first-come, first-served.

Available options:
APPOINTMENT,
FCFS
​
customerName
string | null

The name of the customer

​
accountManagerEmail
string | null

The email address of the account manager responsible for this load

​
stops
LoadStop · object[]

An array of additional stops in between pick up and drop off, each with a type ("pickup" or "dropoff"), address, windowStart, and optional windowEnd

​
equipment
string | null

The type of equipment required for the load

​
minTemperatureF
number | null

The minimum temperature requirement for the load in Fahrenheit

​
maxTemperatureF
number | null

The maximum temperature requirement for the load in Fahrenheit

​
totalDistance
number | null

The total distance of the load in miles

​
weight
number | null

The weight of the load in pounds

​
commodity
string | null

The type of commodity being transported

​
teamServiceRequired
boolean | null

A boolean indicating whether team service is required

​
isHazmat
boolean | null

Whether the load contains hazardous materials

​
customerRate
number | null

The rate charged to the customer

​
startRate
number | null

The starting rate for the load

​
maxRate
number | null

The maximum rate for the load for negotiation

​
bookNowRate
number | null

The rate for booking the load. This is the rate that the bot will relay to the carrier

​
currency
enum<string>

Represents the currency code for rate amounts:

  • USD: United States Dollar
  • CAD: Canadian Dollar
Available options:
USD,
CAD
​
specialInstructions
string | null

Any special instructions for the load

​
shipmentContactNumber
string | null

A string representing a phone number in E.164 format, i.e. "+18008463400". If extension is present, "+15152733178;ext=3178"

​
bookingUrl
string | null

The URL to send to the carrier to book the load, if booking is done through a web portal

​
assignedCarrierMc
string | null

The MC number of the carrier assigned to this load

​
assignedCarrierDot
number | null

The DOT number of the carrier assigned to this load

​
bookedRate
number | null

The final rate that was agreed upon with the carrier

​
outboundCarrierSalesEnabled
boolean | null
default:false

Whether outbound carrier sales is enabled for this load

​
routingGuideEnabled
boolean | null
default:false

Controls whether this load should trigger routing guide campaigns

​
isVisibleToExternalCarriers
boolean | null
default:true

Controls load visibility to external carriers (e.g., phone, or email agents responding to carriers outreach from loadboard)

​
isVisibleToFleetworksCarrierNetwork
boolean | null
default:true

Controls load visibility to Fleetworks Carrier Network

​
locked
boolean | null
default:false

Indicates whether the load is locked. When locked, the load will be conveyed as covered to carriers. This is used to prevent transferring calls from multiple interested carriers if the broker is finalizing a booking with a carrier.

​
isAutoBookable
boolean | null
default:true

Controls whether this load can be automatically booked by FleetWorks AI agents through phone calls and email communications. When set to false, the AI will not complete bookings automatically and will instead transfer to a human broker or provide information only.

Response

Success

​
success
boolean
⌘I