Augment Webhooks v1
Flat outbound webhook payloads that Augment POSTs to URLs configured by your system.
These schemas describe the payloads your listener receives. Your system owns the host, path, and authentication for each webhook endpoint.
Choosing a version
For Capacity Sourcing and Load Building events, v1 and v2 are equivalent — bidCreated, loadDraft, and uploadDocument have identical payloads in both versions.
The v1/v2 split only affects Track & Trace events, which were redesigned in v2. If you might add Track & Trace later, picking v2 up front avoids re-implementing those listeners.
New integrations should use v2. Toggle the version selector at the top of the sidebar to view the v2 reference. If you are already integrated against v1, no action is required — v1 is maintained.
What v2 changes (Track & Trace only):
- Shared event envelope (
id,workflow,occurredAt,loadNumber,brokerageLoadInternalId,eventType,data) — a single listener can route byeventTypeinstead of standing up a separate endpoint per event. - Required / Optional badges on each event, scoped to the workflow it belongs to.
- Workflow-grouped tags (Load Building, Capacity Sourcing, Track & Trace) — the lifecycle order of a load.
v1 → v2 event mapping
| v1 event | v2 event | Notes |
|---|---|---|
trackingEvent |
TRANSIT_UPDATE |
Envelope |
stopUpdate |
STOP_UPDATE |
Envelope |
loadCarrierEvent |
CARRIER_INFO_UPDATE |
Envelope |
comment |
COMMENT |
Envelope |
scheduledCarrierOutreach |
SCHEDULED_CARRIER_OUTREACH |
Envelope |
uploadDocument |
uploadDocument |
Unchanged — flat payload |
bidCreated |
bidCreated |
Unchanged — flat payload |
loadDraft |
loadDraft |
Unchanged — flat payload |