Required

Stop Update

v1 equivalent: stopUpdate (flat payload).

Sent when a stop's status changes. For example, when a driver arrives at a pickup, departs a facility, or a delivery is completed. Contains the stop sequence, updated status, timing information, and the stop's address when it is known.

Body·

required

application/json

Fields present on every v2 webhook event.

- customerLoadInternalId
  Type: string | null
  required
  
  Your internal load ID, if provided during load creation
- data
  Type:
  required
  
  Stop update data payload.
  
  Properties: 12
- eventType
  enum
  const:
  STOP_UPDATE
  required
  
  Event name for a stop status update.
- id
  Type: string
  required
  
  Unique event identifier (ULID)
- loadNumber
  Type: string | null
  required
  
  Your load reference number
- occurredAt
  Type: stringFormat: date-time
  required
  
  When the underlying activity occurred (ISO 8601)
- workflow
  Type: string | nullenum
  required
  
  The Augment workflow that produced this event, or null when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.
  
  values
  TRACK_AND_TRACECARRIER_SUPPORTPOD_COLLECTIONLOAD_BUILDINGCARRIER_SELECTIONSCHEDULINGCUSTOMER_SUPPORTnull

Responses

200

Event acknowledged

post/STOP_UPDATE

curl /STOP_UPDATE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "",
  "loadNumber": "",
  "customerLoadInternalId": "",
  "eventType": "STOP_UPDATE",
  "data": {
    "stopSequenceNumber": 1,
    "status": "AT_PICKUP",
    "arrivalTime": "",
    "departureTime": "",
    "timezone": "",
    "notes": "",
    "address": {
      "street1": "1621 Welch St",
      "city": "Brownsville",
      "stateOrProvince": "TN",
      "postalCode": "38012",
      "country": "US"
    }
  }
}'

No Body

Event acknowledged

Transit Update

Carrier Info Update

Stop Update

Body·StopUpdateEvent

Responses

Body·