Webhooks
Overview
Webhooks are outbound POST requests from Augment to endpoints you configure. Use this reference to see the payload for each event your system can receive.
Events are grouped by workflow. Some workflows use a shared event envelope with eventType and data; others use callback-specific payloads. Follow the schema on each event page for the exact request body.
Each event is marked as Required or Optional for the workflow it belongs to.
Return a 200 status code to acknowledge receipt. During setup, provide your endpoint URL(s), the events each endpoint should receive, and your preferred authentication method.
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. v1 remains supported for existing integrations — no migration is required if you are already live.
What's new in v2 (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) so events are organized by integration surface — the lifecycle order of a load.
Track & Trace envelope shape
All redesigned Track & Trace events in v2 share this envelope:
{
"id": "evt_01H...",
"workflow": "TRACK_AND_TRACE",
"occurredAt": "2026-05-13T12:34:56Z",
"loadNumber": "LOAD-456",
"brokerageLoadInternalId": "INT-789",
"eventType": "TRANSIT_UPDATE",
"data": { /* event-specific fields */ }
}
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 |