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
Fields present on every v2 webhook event.
- Type: string | nullcustomer
Load Internal Id requiredYour internal load ID, if provided during load creation
- Type:datarequiredProperties: 3
Scheduled carrier outreach data payload.
- enumevent
Type const:SCHEDULED_CARRIER_OUTREACHrequiredEvent name for scheduled carrier outreach.
- Type: stringidrequired
Unique event identifier (ULID)
- Type: string | nullload
Number requiredYour load reference number
- Type: stringFormat: date-timeoccurred
At requiredWhen the underlying activity occurred (ISO 8601)
- Type: string | nullenumworkflowrequired
The Augment workflow that produced this event, or
nullwhen 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.valuesTRACK_AND_TRACECARRIER_SUPPORTPOD_COLLECTIONLOAD_BUILDINGCARRIER_SELECTIONSCHEDULINGCUSTOMER_SUPPORTnull
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