Required

Transit Update

​

v1 equivalent: trackingEvent (flat payload).

Sent when Augment receives a location or tracking update from a carrier communication. Contains the driver's current position, the next stop ETA, and the source of the tracking data.

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/TRANSIT_UPDATE
curl /TRANSIT_UPDATE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "",
  "loadNumber": "",
  "brokerageLoadInternalId": "",
  "eventType": "TRANSIT_UPDATE",
  "data": {
    "nextSequence": 1,
    "nextEtaUtc": "",
    "eventType": "PING",
    "eventSource": "PHONE_EMAIL",
    "eventUtc": "",
    "city": "",
    "stateOrProvince": "",
    "latitude": 0,
    "longitude": 0,
    "notes": ""
  }
}'
No Body

Event acknowledged