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, and timing information.

Body·
required
application/json

  • Common envelope shared by Track & Trace webhook events. Use eventType to determine how to interpret the data field.

    • brokerageLoadInternalId
      Type: string | null
      required

      Your internal load ID, if provided during load creation

    • data
      required
    • eventType
      Type: stringenum
      required

      Determines the shape of data

      values
      • TRANSIT_UPDATE
      • STOP_UPDATE
      • CARRIER_INFO_UPDATE
      • COMMENT
      • SCHEDULED_CARRIER_OUTREACH
    • 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

      values
      • TRACK_AND_TRACE
      • null
Responses
  • 200

    Event acknowledged

Request Example for post/STOP_UPDATE
curl /STOP_UPDATE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "",
  "loadNumber": "",
  "brokerageLoadInternalId": "",
  "eventType": "STOP_UPDATE",
  "data": {
    "stopSequenceNumber": 1,
    "status": "AT_PICKUP",
    "arrivalTime": "",
    "departureTime": "",
    "timezone": "",
    "notes": ""
  }
}'
No Body

Event acknowledged