Agent Activity

Canceled Scheduled Outreach

v1 equivalent: none. v2 only.

Sent when a carrier outreach that Augment had scheduled is canceled before it ran. The data payload describes the outreach that was canceled and is the same shape as SCHEDULED_CARRIER_OUTREACH, so you can match it against the outreach you recorded earlier. occurredAt is when the cancellation happened; scheduledAt is when the outreach would have run.

Sent only for outreach directed at a contact — a call, email, or text that will now not happen.

post/CANCELED_SCHEDULED_OUTREACH

Request

Base URL
https://apidocs.goaugment.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/goaugment/apis/webhooks/docs/CANCELED_SCHEDULED_OUTREACH/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'CANCELED_SCHEDULED_OUTREACH' required

Event name for a canceled scheduled carrier outreach.

Example request

{
  "data": {
    "scheduledAt": "2025-08-21T12:34:56Z"
  }
}

Changes

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