Webhooks Setup

Outbound webhooks are POST requests Augment sends to URLs you configure when an event occurs in a workflow you're integrated with. Your TMS owns the host, path, and authentication for each endpoint; Augment owns the event payload.

Which version should I use?

For Capacity Sourcing and Load Building events, v1 and v2 are equivalent — bidCreated, loadDraft, and uploadDocument are byte-identical between v1 and v2.

The v1/v2 split only affects Track & Trace events, which were redesigned in v2.

New integrations should use v2. Even if you're starting with Capacity Sourcing or Load Building today, picking v2 up front avoids re-implementing listeners if you add Track & Trace in a later wave. v1 remains supported for existing integrations — no migration is required if you are already live on v1.

	v1	v2
Load Building & Capacity Sourcing events	Flat payload	Identical to v1
Track & Trace events	Flat payload per event	Shared envelope (`eventType` + `data`)
Required / Optional badges	Implicit	Marked per event
Workflow grouping in sidebar	One tag	Grouped by workflow

See the full v1 → v2 event mapping at the top of the Webhooks reference.

What you provide to Augment

During setup, hand the following to your Augment CS contact:

Endpoint URL(s) — one or more URLs that will receive webhook POSTs.
Event routing — which events each endpoint should receive (you may use a single endpoint for all events and route internally by eventType).
Authentication method — Augment supports multiple auth types (Basic, Bearer token, custom header). Specify which to use per endpoint.

Your listener must return a 200 status code to acknowledge receipt.

Required and optional events per workflow

Workflows are listed in load lifecycle order. v2 names shown first; v1 names in parentheses.

Load Building

Event	Required?
`loadDraft`	Required
`uploadDocument`	Optional

Capacity Sourcing

Event	Required?	Notes
`bidCreated`	Required	Configure a `PUSH_BID_TO_TMS` subscription to receive these.

Track & Trace

Event	v2 name	v1 name	Required?
Stop status change	`STOP_UPDATE`	`stopUpdate`	Required
Location / ETA update	`TRANSIT_UPDATE`	`trackingEvent`	Required
Carrier info change	`CARRIER_INFO_UPDATE`	`loadCarrierEvent`	Required
Unstructured communication	`COMMENT`	`comment`	Optional
Scheduled outreach	`SCHEDULED_CARRIER_OUTREACH`	`scheduledCarrierOutreach`	Optional

Track & Trace event envelope (v2 only)

All redesigned Track & Trace events in v2 share this envelope. A single listener can route by eventType:

{
  "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 */ }
}

uploadDocument, bidCreated, and loadDraft are not wrapped in this envelope — they use their documented flat payloads in both v1 and v2.

Testing

Work with your Augment CS contact to send test webhooks and verify your endpoints receive and process them correctly. Design your handlers to be idempotent — Augment retries failed deliveries with exponential backoff, which may result in the same event being delivered more than once.

Questions?

Reach out to your CS contact for help setting up or testing your webhook subscriptions.

Rate Limits