Optional

Appointment Update

Sent once Augment schedules an appointment with a facility for a stop on a load.

Clients must configure a PUSH_APPOINTMENT_UPDATE webhook subscription to receive this event. Ask your Augment contact to set one up.

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: object ·
      required

      Contains the stops whose appointments were updated.

    • eventType
      enum
      const:  
      APPOINTMENT_UPDATE
      required

      Event name for a stop appointment update.

      values
      • APPOINTMENT_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, 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_TRACE
      • CARRIER_SUPPORT
      • POD_COLLECTION
      • LOAD_BUILDING
      • CARRIER_SELECTION
      • SCHEDULING
      • CUSTOMER_SUPPORT
      • null
Responses
  • 200

    Appointment update received successfully

Request Example for post/APPOINTMENT_UPDATE
curl /APPOINTMENT_UPDATE \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "01JN3GVAY1T1V8E5VFXY4N2K9X",
  "workflow": "SCHEDULING",
  "occurredAt": "2026-07-09T18:22:41Z",
  "loadNumber": "LOAD-12345",
  "customerLoadInternalId": "internal-123",
  "eventType": "APPOINTMENT_UPDATE",
  "data": {
    "route": [
      {
        "sequence": 1,
        "appointmentConfirmation": {
          "start": "2026-07-10T13:30:00.000Z",
          "end": "2026-07-10T14:00:00.000Z",
          "timezone": "America/Chicago",
          "confirmationId": "CONF-12345"
        }
      }
    ]
  }
}'
No Body