Trigger a check call, providing stops

Trigger an immediate outbound check-call to verify the status of a load. After the AI agent speaks with the driver or carrier, FleetWorks posts the results back to your webhook. The call is initiated immediately upon request.

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

toPhone · string · required

Phone number to call in E.164 format. Must include country code with + prefix (e.g., [phone]). For extensions, append ;ext= followed by the extension number (e.g., [phone];ext=123).

Example:

"[phone]"

callType · enum<string> · required

Type of check-call the agent should run: • pickup (before/during pickup stop) • dropoff (before/during drop-off stop) Pick the one that best matches the driver's next stop.

Available options:

pickup,

dropoff

Example:

"pickup"

nextStopApptStart · string · required

Start of the appointment window (local stop-timezone).

Example:

"2025-03-06T08:00:00"

nextStopApptEnd · string · required

End of the appointment window for the next stop. Use the same value as start for FCFS.

Example:

"2025-03-06T10:00:00"

nextStopCity · string · required

City of the next stop.

nextStopState · string · required

State / province abbreviation of the next stop.

Example:

"IL"

loadNumber · string · required

Your load reference number. This is used for context during the call and in the extracted data.

Example:

"FW-123456"

loadStops · object[] · required

Required. Ordered list of all stops on the load. The agent uses this for context and the last stop in the array is used to determine the final destination information (city, state, appointment times).

Show child attributes

driverName · string

Optional. The driver's name for context; used to personalize the call.

Example:

"John Smith"

reeferTemp · string

Optional. Target trailer temperature (e.g. 34). If provided, the load is considered a reefer load. Including it lets the agent confirm the driver is at the correct reefer temp. Also supports ranges.

waitingAtFacility · boolean

Optional. Set to true if the driver is already at the facility (shipper for pickup, receiver for dropoff). Helps the agent skip unnecessary ETA questions.

trackingOperatorPhone · string

Optional. Phone number to escalate the call to if the driver requests to speak with dispatch. Should be an E.164 formatted number (e.g. [phone]).

Example:

"[phone]"

contactName · string

Optional. Name of the person being called (e.g., dispatcher).

Example:

"Alex Johnson"

contactType · enum<string>

Optional. Whether you're speaking to the driver or a dispatcher.

Available options:

driver,

dispatcher

askForTrackingApp · enum<string>

Optional. Request the driver to enable a specific tracking app. Valid values are "macropoint" or "fourkites". When provided, the AI agent will ask the driver to enable the specified tracking app during the call.

Available options:

macropoint,

fourkites

Example:

"macropoint"

metadata · object

Optional. Custom metadata as key-value pairs that will be included in webhook events. This allows you to map calls back to your internal systems when receiving webhooks. Values can be strings or numbers.

Show child attributes

Example:

{
  "internal_load_id": "ABC123",
  "customer_id": "12345",
  "priority": 1
}

Response

200

application/json

Success

success · boolean

call · object | null

Call details if the call was successfully initiated.

Show child attributes