v2.1.0
OpenAPI 3.1.1

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.

Self-service webhook management

To self-manage webhook endpoints, event subscriptions, supported event types, and test deliveries, use Webhook Endpoints and Webhook Event Subscriptions. Access is gated. Request access from Augment.

Choosing a version

v2 wraps every load event in the shared event envelope (id, workflow, occurredAt, loadNumber, customerLoadInternalId, eventType, data) — including Capacity Sourcing and Load Building events (BID_CREATED, LOAD_DRAFT, UPLOAD_DOCUMENT). In v1, those three are delivered as flat payloads and Track & Trace uses per-event shapes. Events that are not about a load — Purchase Order Management — carry no envelope, since its load references would have nothing to hold. The domain fields carried in data are the same across versions — only the wrapping differs, so a single v2 listener can route by eventType.

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:

  • Shared event envelope (id, workflow, occurredAt, loadNumber, customerLoadInternalId, eventType, data) — a single listener can route by eventType instead 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.
  • Agent Activity events — calls, emails, text messages, workflow status changes, and human-assistance requests, reporting what an Augment agent did on a load. These have no v1 equivalent. Ask your Augment contact to set up a subscription.

Event envelope shape

Every v2 event about a load shares this envelope. workflow is the originating Augment workflow, or null when no single workflow can be attributed to the event. Treat the set of values as open: new workflows may be added over time, so a listener should tolerate a value it has not seen before:

{
  "id": "evt_01H...",
  "workflow": "TRACK_AND_TRACE",
  "occurredAt": "2026-05-13T12:34:56Z",
  "loadNumber": "LOAD-456",
  "customerLoadInternalId": "INT-789",
  "eventType": "TRACKING_UPDATE",
  "data": { /* event-specific fields */ }
}

Purchase Order Management events are the exception: they are not about a load, so they arrive as flat payloads with no envelope around them.

v1 → v2 event mapping

v1 event v2 event Notes
trackingEvent TRACKING_UPDATE Envelope
stopUpdate STOP_UPDATE Envelope
loadCarrierEvent LOAD_CARRIER_UPDATE Envelope
comment SEND_TMS_COMMENT Envelope
scheduledCarrierOutreach SCHEDULED_CARRIER_OUTREACH Envelope
uploadDocument UPLOAD_DOCUMENT Envelope (v1 flat)
bidCreated BID_CREATED Envelope (v1 flat)
loadDraft LOAD_DRAFT Envelope (v1 flat)
Client Libraries