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.

Forward compatibility

As our agents do more on a load, the data we send back grows with them. New capabilities arrive as optional fields added to existing payloads — with no version change and nothing for you to coordinate. These additions are backward-compatible: existing fields keep their name, type, and meaning, and nothing is removed or renamed. Only a breaking change — removing a field, renaming one, or changing its type — ships under a new version.

So new fields never disrupt you, build your listener as a tolerant reader:

• Ignore fields you don't recognize. Read what your workflow needs and pass over the rest.
• Don't enforce a closed schema. Validation that rejects unknown properties (JSON Schema additionalProperties: false, or a strict downstream RPA / iPaaS queue) breaks the first time we add a field. Allow unknown properties throughout your delivery path.
• Acknowledge with 200 whenever the payload is well-formed and carries the fields you require.

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, 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) — the lifecycle order of a load.

v1 → v2 event mapping