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 fields shared by v2 webhook events. Each concrete event schema adds its own eventType and typed data payload.

    • customerLoadInternalId
      Type: string | null
      required

      Your internal load ID, if provided during load creation

    • data
      Type: object ·
      required

      Stop update data payload.

    • eventType
      enum
      const:  
      STOP_UPDATE
      required

      Event name for a stop status update.

      values
      • STOP_UPDATE
    • id
      Type: string
      required

      Unique event identifier (ULID)

    • loadNumber
      Type: string | null
      required

      Your load reference number

    • occurredAt
      Type: string Format: date-time
      required

      When the underlying activity occurred (ISO 8601)

    • workflow
      Type: string | null enum
      required

      The Augment workflow that produced this event

      values
      • TRACK_AND_TRACE
      • CARRIER_SUPPORT
      • 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": "",
  "customerLoadInternalId": "",
  "eventType": "STOP_UPDATE",
  "data": {
    "stopSequenceNumber": 1,
    "status": "AT_PICKUP",
    "arrivalTime": "",
    "departureTime": "",
    "timezone": "",
    "notes": ""
  }
}'
No Body

Event acknowledged