Appointment Scheduling

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.

post/APPOINTMENT_UPDATE

Request

Base URL
https://apidocs.goaugment.com (the document declares no server; this is the origin it was published from)
Auth
none required
TypeScript
https://skmtc.dev/goaugment/apis/webhooks/docs/APPOINTMENT_UPDATE/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

Unique event identifier (ULID)

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.

occurredAtstring date-time required

When the underlying activity occurred (ISO 8601)

loadNumberstring nullable required

Your load reference number

customerLoadInternalIdstring nullable required

Your internal load ID, if provided during load creation

eventType'APPOINTMENT_UPDATE' required

Event name for a stop appointment update.

Example request

{
  "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"
        },
        "externalId": "EXT-STOP-99"
      }
    ]
  }
}

Response

Appointment update received successfully

Changes

No recorded changes to this operation across all 1 revision of this API.