Optional

Scheduled Carrier Outreach

​

v1 equivalent: scheduledCarrierOutreach (flat payload).

Sent when Augment schedules a future Track & Trace carrier outreach for a load. Clients must configure a SCHEDULED_CARRIER_OUTREACH webhook subscription to receive these events.

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

      Scheduled carrier outreach data payload.

    • eventType
      enum
      const:  
      SCHEDULED_CARRIER_OUTREACH
      required

      Event name for scheduled carrier outreach.

      values
      • SCHEDULED_CARRIER_OUTREACH
    • 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

    Scheduled carrier outreach received successfully

Request Example for post/SCHEDULED_CARRIER_OUTREACH
curl /SCHEDULED_CARRIER_OUTREACH \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "",
  "loadNumber": "",
  "customerLoadInternalId": "",
  "eventType": "SCHEDULED_CARRIER_OUTREACH",
  "data": {
    "scheduledAt": "2025-08-21T12:34:56Z",
    "outreachType": "PHONE_CALL",
    "context": "Follow up on delivery ETA"
  }
}'
No Body

Scheduled carrier outreach received successfully