{ "openapi": "3.1.1", "info": { "title": "Webhooks", "description": "## Overview\n\nWebhooks are outbound `POST` requests from Augment to endpoints you configure. Use this reference to see the payload for each event your system can receive.\n\nEvents 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.\n\nEach event is marked as **Required** or **Optional** for the workflow it belongs to.\n\nReturn 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.\n\n## Forward compatibility\n\nAs our agents do more on a load, the data we send back grows with them. New\ncapabilities arrive as **optional** fields added to existing objects — the\nenvelope or an event's `data` — with no version change and nothing for you to\ncoordinate. These additions are backward-compatible: existing fields keep\ntheir name, type, and meaning, and nothing is removed or renamed. Only a\nbreaking change — removing a field, renaming one, or changing its type — ships\nunder a new version.\n\nSo new fields never disrupt you, build your listener as a **tolerant reader**:\n\n- **Ignore fields you don't recognize.** Read what your workflow needs and\n pass over the rest.\n- **Don't enforce a closed schema.** Validation that rejects unknown\n properties (JSON Schema `additionalProperties: false`, or a strict\n downstream RPA / iPaaS queue) breaks the first time we add a field. Allow\n unknown properties throughout your delivery path.\n- **Acknowledge with `200`** whenever the payload is well-formed and carries\n the fields you require.\n\n## Self-service webhook management\n\nTo self-manage webhook endpoints, event subscriptions, supported event\ntypes, and test deliveries, use\n[Webhook Endpoints](/reference/tag/webhook-endpoints) and\n[Webhook Event Subscriptions](/reference/tag/webhook-event-subscriptions).\nAccess is gated. Request access from Augment.\n\n## Choosing a version\n\n**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`.\n\n**New integrations should use v2.** v1 remains supported for existing integrations — no migration is required if you are already live.\n\nWhat's new in v2:\n\n- **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.\n- **Required / Optional badges** on each event, scoped to the workflow it belongs to.\n- **Workflow-grouped tags** (Load Building, Capacity Sourcing, Track & Trace) so events are organized by integration surface — the lifecycle order of a load.\n- **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.\n\n### Event envelope shape\n\nEvery v2 event about a load shares this envelope. `workflow` is the\noriginating Augment workflow, or `null` when no single workflow can be\nattributed to the event. Treat the set of values as open: new workflows may\nbe added over time, so a listener should tolerate a value it has not seen\nbefore:\n\n```json\n{\n \"id\": \"evt_01H...\",\n \"workflow\": \"TRACK_AND_TRACE\",\n \"occurredAt\": \"2026-05-13T12:34:56Z\",\n \"loadNumber\": \"LOAD-456\",\n \"customerLoadInternalId\": \"INT-789\",\n \"eventType\": \"TRACKING_UPDATE\",\n \"data\": { /* event-specific fields */ }\n}\n```\n\nPurchase Order Management events are the exception: they are not about a\nload, so they arrive as flat payloads with no envelope around them.\n\n### v1 → v2 event mapping\n\n| v1 event | v2 event | Notes |\n|---|---|---|\n| `trackingEvent` | `TRACKING_UPDATE` | Envelope |\n| `stopUpdate` | `STOP_UPDATE` | Envelope |\n| `loadCarrierEvent` | `LOAD_CARRIER_UPDATE` | Envelope |\n| `comment` | `SEND_TMS_COMMENT` | Envelope |\n| `scheduledCarrierOutreach` | `SCHEDULED_CARRIER_OUTREACH` | Envelope |\n| `uploadDocument` | `UPLOAD_DOCUMENT` | Envelope (v1 flat) |\n| `bidCreated` | `BID_CREATED` | Envelope (v1 flat) |\n| `loadDraft` | `LOAD_DRAFT` | Envelope (v1 flat) |\n", "version": "2.1.1" }, "tags": [ { "name": "Load Building", "description": "Events produced by load creation and document handling workflows.\n" }, { "name": "Capacity Sourcing", "description": "Events produced by carrier bid and selection workflows. (Formerly referred to as Carrier Selection.)\n" }, { "name": "Appointment Scheduling", "description": "Events produced by the appointment scheduling workflow.\n" }, { "name": "Track & Trace", "description": "Load tracking, stop status, carrier information, communication, and scheduled outreach events.\n" }, { "name": "Agent Activity", "description": "What an Augment agent did on a load — calls placed and received, emails sent and received, text messages, workflow status changes, and human-assistance requests.\n\nUnlike the other tags, these are not scoped to one workflow: any agent can emit them, so read `workflow` on the envelope to see which one did.\n\nAsk your Augment contact to set up a subscription to these events.\n" }, { "name": "Purchase Order Management", "description": "What Augment learned from a supplier about a purchase order, sent back so your system can apply it. Today this is new expected dates for a purchase order and its lines.\n\nThese events are delivered as flat payloads rather than in the shared event envelope, which describes work on a load. There is no v1 equivalent.\n\nAsk your Augment contact to set up a subscription to these events.\n" } ], "paths": { "/TRACKING_UPDATE": { "post": { "tags": [ "Track & Trace" ], "operationId": "receiveTransitUpdate", "summary": "Transit Update", "x-badges": [ { "name": "Required", "color": "#0f766e" } ], "description": "> v1 equivalent: `trackingEvent` (flat payload).\n\nSent when Augment receives a location or tracking update from a carrier communication. Contains the driver's current position, the next stop ETA, and the source of the tracking data.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitUpdateEvent" }, "example": { "id": "", "workflow": "TRACK_AND_TRACE", "occurredAt": "", "loadNumber": "", "customerLoadInternalId": "", "eventType": "TRACKING_UPDATE", "data": { "nextSequence": 1, "nextEtaUtc": "", "eventType": "PING", "eventSource": "PHONE_EMAIL", "eventUtc": "", "city": "", "stateOrProvince": "", "latitude": 0, "longitude": 0, "notes": "" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/STOP_UPDATE": { "post": { "tags": [ "Track & Trace" ], "operationId": "receiveStopUpdate", "summary": "Stop Update", "x-badges": [ { "name": "Required", "color": "#0f766e" } ], "description": "> v1 equivalent: `stopUpdate` (flat payload).\n\nSent when a stop's status changes. For example, when a driver arrives at a pickup, departs a facility, or a delivery is completed. Contains the stop sequence, updated status, timing information, and the stop's address when it is known.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StopUpdateEvent" }, "example": { "id": "", "workflow": "TRACK_AND_TRACE", "occurredAt": "", "loadNumber": "", "customerLoadInternalId": "", "eventType": "STOP_UPDATE", "data": { "stopSequenceNumber": 1, "status": "AT_PICKUP", "arrivalTime": "", "departureTime": "", "timezone": "", "notes": "", "address": { "street1": "1621 Welch St", "city": "Brownsville", "stateOrProvince": "TN", "postalCode": "38012", "country": "US" } } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/LOAD_CARRIER_UPDATE": { "post": { "tags": [ "Track & Trace" ], "operationId": "receiveCarrierInfoUpdate", "summary": "Carrier Info Update", "x-badges": [ { "name": "Required", "color": "#0f766e" } ], "description": "> v1 equivalent: `loadCarrierEvent` (flat payload).\n\nSent when Augment obtains updated driver, truck, or trailer information from a carrier. This may include the driver's name and phone number, truck and trailer numbers, or a Bill of Lading number.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierInfoUpdateEvent" }, "example": { "id": "", "workflow": "TRACK_AND_TRACE", "occurredAt": "", "loadNumber": "", "customerLoadInternalId": "", "eventType": "LOAD_CARRIER_UPDATE", "data": { "driverName": "", "driverPhoneNumber": "", "truckNumber": "", "trailerNumber": "", "bolNumber": "", "source": "EMAIL", "notes": "" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/SEND_TMS_COMMENT": { "post": { "tags": [ "Track & Trace" ], "operationId": "receiveComment", "summary": "Comment", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: `comment` (flat payload).\n\nSent when Augment sends or receives a carrier communication (email, phone, or text) that does not produce a distinct structured event like `TRACKING_UPDATE`, `STOP_UPDATE` or `LOAD_CARRIER_UPDATE`. Use this event to capture communication activity that does not map to a specific tracking or carrier update.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommentEvent" }, "example": { "id": "", "workflow": "TRACK_AND_TRACE", "occurredAt": "", "loadNumber": "", "customerLoadInternalId": "", "eventType": "SEND_TMS_COMMENT", "data": { "comment": "Driver Marcus confirmed pickup of load test12345 from Dallas and is en route to Atlanta with ETA of tomorrow 2pm." } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/SCHEDULED_CARRIER_OUTREACH": { "post": { "tags": [ "Track & Trace" ], "operationId": "receiveScheduledCarrierOutreach", "summary": "Scheduled Carrier Outreach", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: `scheduledCarrierOutreach` (flat payload).\n\nSent when Augment schedules a future Track & Trace carrier outreach for a load. Clients must configure a `SCHEDULED_CARRIER_OUTREACH` webhook subscription to receive these events.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduledCarrierOutreachCallbackResponse" }, "example": { "id": "", "workflow": "TRACK_AND_TRACE", "occurredAt": "", "loadNumber": "", "customerLoadInternalId": "", "eventType": "SCHEDULED_CARRIER_OUTREACH", "data": { "scheduledAt": "2025-08-21T12:34:56Z", "outreachType": "PHONE_CALL", "context": "Follow up on delivery ETA" } } } } }, "responses": { "200": { "description": "Scheduled carrier outreach received successfully" } } } }, "/CARRIER_ISSUE_UPDATED": { "post": { "tags": [ "Carrier Support" ], "operationId": "receiveCarrierIssueUpdated", "summary": "Carrier Issue Updated", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "Sent when a carrier issue (detention, lumper, TONU, breakdown, damage, shortage, overage, or other incident) is created or updated on a load. Clients must configure a `CARRIER_ISSUE_UPDATED` webhook subscription to receive these events.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierIssueUpdatedEvent" }, "example": { "id": "01JN3GVAY1T1V8E5VFXY4N2K9X", "workflow": "CARRIER_SUPPORT", "occurredAt": "2026-06-16T14:00:00Z", "loadNumber": "LOAD-12345", "customerLoadInternalId": "internal-123", "eventType": "CARRIER_ISSUE_UPDATED", "data": { "carrierIssueId": "01JCARRIERISSUERECORD00001", "issueType": "DETENTION_PICKUP", "status": "OPEN", "stopType": "PICKUP", "stopSequenceNumber": 1, "amountCents": 15000, "waitTimeMinutes": 180, "description": "Carrier reported 3-hour wait at shipper. Appointment was 08:00, arrived 07:45, still not loaded as of 11:00.", "resolution": null, "externalId": "TMS-INC-30275" } } } } }, "responses": { "200": { "description": "Carrier issue update received successfully" } } } }, "/APPOINTMENT_UPDATE": { "post": { "operationId": "receiveAppointmentUpdate", "tags": [ "Appointment Scheduling" ], "summary": "Appointment Update", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "security": [], "description": "Sent once Augment schedules an appointment with a facility for a stop on a load.\n\nClients must configure a `PUSH_APPOINTMENT_UPDATE` webhook subscription to receive this event. Ask your Augment contact to set one up.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppointmentUpdateEvent" }, "example": { "id": "01JN3GVAY1T1V8E5VFXY4N2K9X", "workflow": "SCHEDULING", "occurredAt": "2026-07-09T18:22:41Z", "loadNumber": "LOAD-12345", "customerLoadInternalId": "internal-123", "eventType": "APPOINTMENT_UPDATE", "data": { "route": [ { "sequence": 1, "appointmentConfirmation": { "start": "2026-07-10T13:30:00.000Z", "end": "2026-07-10T14:00:00.000Z", "timezone": "America/Chicago", "confirmationId": "CONF-12345" }, "externalId": "EXT-STOP-99" } ] } } } } }, "responses": { "200": { "description": "Appointment update received successfully" } } } }, "/UPLOAD_DOCUMENT": { "post": { "operationId": "receiveUploadDocument", "tags": [ "Load Building" ], "summary": "Upload Document", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "security": [], "description": "> v1 equivalent: `uploadDocument` (flat payload — the `data` fields below are sent at the top level, without the envelope).\n\nSent when a document needs to be associated with a load. `workflow` is `null`, because more than one workflow can upload documents and the originating one is not attributable on this event. `loadNumber` / `customerLoadInternalId` are the load's references.\n\nTwo delivery encodings, selected by your endpoint's configuration:\n\n- **`application/json`** (default): the file bytes are base64-encoded in `data.content`, wrapped in the standard envelope.\n\n- **`multipart/form-data`** (when your endpoint is configured for multipart): the raw file bytes are sent as a `content` file part, and the envelope travels as a JSON `envelope` part whose `data` omits `content`.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UploadDocumentEvent" }, "example": { "id": "01JR7ZC3M8Q9W2D4F6H8K0N2P4", "workflow": null, "occurredAt": "2026-07-01T09:00:00Z", "loadNumber": "LOAD-12345", "customerLoadInternalId": "INT-789", "eventType": "UPLOAD_DOCUMENT", "data": { "loadNum": "LOAD-12345", "internalLoadReference": "INT-789", "filename": "invoice-1234.pdf", "fileType": "INVOICE", "contentType": "application/pdf", "content": "JVBERi0xLjcKJcTl8uXrp/Og0MTGCg==", "sizeBytes": 20481, "checksum": "9f86d081884c7d659a2feaa0c55ad015" } } }, "multipart/form-data": { "schema": { "type": "object", "required": [ "content", "envelope" ], "x-property-order": [ "content", "envelope" ], "properties": { "content": { "type": "string", "format": "binary", "description": "The raw file bytes (the document), sent as a file part." }, "envelope": { "type": "string", "description": "JSON-encoded UPLOAD_DOCUMENT envelope, identical to the `application/json` body above except `data.content` is omitted — the file bytes travel as the `content` part instead.\n" } } }, "encoding": { "content": { "contentType": "application/octet-stream" }, "envelope": { "contentType": "application/json" } } } } }, "responses": { "200": { "description": "Upload results, including per-file success or failure details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchFileUploadResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiErrorBody" } } } } } } }, "/BID_CREATED": { "post": { "operationId": "receiveBidCreated", "tags": [ "Capacity Sourcing" ], "summary": "Bid Created", "x-badges": [ { "name": "Required", "color": "#0f766e" } ], "security": [], "description": "> v1 equivalent: `bidCreated` (flat payload — the `data` fields below are sent at the top level, without the envelope).\n\nSent when a carrier expresses interest in a load, including when the carrier did not provide a dollar amount. Clients must configure a `PUSH_BID_TO_TMS` webhook subscription to receive these callbacks. `offerAmount` can be `null`. `workflow` is `CARRIER_SELECTION`.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BidCreatedEvent" }, "example": { "id": "01JN3GVAY1T1V8E5VFXY4N2K9X", "workflow": "CARRIER_SELECTION", "occurredAt": "2026-02-19T14:30:00.000Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "BID_CREATED", "data": { "bidId": "bid-abc-123", "createdAt": "2026-02-19T14:30:00.000Z", "loadReference": "LOAD-456", "internalLoadReference": "INT-789", "carrier": { "id": "carrier-001", "mcNumber": 123456, "dotNumber": 7890123 }, "offerAmount": 2500, "channel": { "type": "call", "phone": "+15551234567" }, "truckEmpty": { "city": "Dallas", "stateOrProvince": "TX", "country": "US", "dateTime": "2026-02-20T08:00:00.000Z" }, "repId": "rep-456" } } } } }, "responses": { "200": { "description": "Bid received successfully" } } } }, "/LOAD_DRAFT": { "post": { "operationId": "receiveLoadDraft", "tags": [ "Load Building" ], "summary": "Load Draft", "x-badges": [ { "name": "Required", "color": "#0f766e" } ], "security": [], "description": "> v1 equivalent: `loadDraft` (flat payload — the `data` fields below are sent at the top level, without the envelope).\n\nSent when Augment's load building agent has assembled a load draft and is ready to create a load in the TMS. `workflow` is `LOAD_BUILDING`. The envelope `loadNumber` / `customerLoadInternalId` are `null` because the load does not exist in the TMS yet.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadDraftEvent" }, "example": { "id": "01JR7ZC3M8Q9W2D4F6H8K0N2P4", "workflow": "LOAD_BUILDING", "occurredAt": "2026-07-01T09:00:00Z", "loadNumber": null, "customerLoadInternalId": null, "eventType": "LOAD_DRAFT", "data": { "loadDraftId": "01JR7ZC3M8Q9W2D4F6H8K0N2P4", "referenceNumbers": { "customerReferenceNumber": "CUST-REF-12345", "bolNumber": "BOL-9988", "poNumber": "PO-44521", "shipmentNumber": "SHP-2026-0042" }, "customerInformation": { "name": "Acme Foods Inc.", "contact": { "email": "ops@acme-foods.example.com", "phone": "+13125550199" }, "address": { "name": "Acme HQ", "streetAddress": "500 W Madison St", "city": "Chicago", "state": "IL", "zip": "60661", "country": "US" }, "shipperId": "SHIPPER-ACME-001", "notes": "Call 1 hour before arrival", "internalNotes": "Tier 1 customer: escalate any delays" }, "stops": [ { "stopNumber": 1, "stopType": "PICKUP", "facilityName": "Acme DC - Chicago", "facilityCode": "ACM-CHI-01", "facilityAddress": { "streetAddress": "1200 S Cicero Ave", "city": "Chicago", "state": "IL", "zip": "60623", "country": "US" }, "facilityContact": { "email": "dock@acme-chi.example.com", "phone": "+17735550144" }, "handlingType": "LIVE", "appointmentType": "APPOINTMENT", "appointmentTime": { "start": "2026-07-02T13:00:00Z", "end": "2026-07-02T15:00:00Z", "timezone": "America/Chicago" }, "driverInstructions": "Check in at guard shack with BOL" }, { "stopNumber": 2, "stopType": "DELIVERY", "facilityName": "Midwest Grocers DC", "facilityAddress": { "streetAddress": "8400 Industrial Pkwy", "city": "Detroit", "state": "MI", "zip": "48210", "country": "US" }, "handlingType": "DROP_TRAILER", "appointmentType": "FIRST_COME_FIRST_SERVE", "dropTime": { "start": "2026-07-03T10:00:00Z", "end": "2026-07-03T22:00:00Z", "timezone": "America/Detroit" } } ], "loadDetails": { "handlingUnit": { "unitType": "PALLET", "unitCount": "24" }, "commodity": "Mixed frozen goods", "weight": { "value": "42000", "unit": "LBS" }, "dimensions": { "length": "48", "lengthUnit": "IN", "width": "40", "widthUnit": "IN", "height": "60", "heightUnit": "IN" }, "cargoCharacteristics": { "stackable": false, "hazmat": false, "perishable": true }, "cargoItems": [ { "handlingUnit": { "unitType": "PALLET", "unitCount": "14" }, "packagingUnit": { "unitType": "CARTON", "unitCount": "560" }, "commodity": "Frozen poultry", "description": "Boxed frozen poultry, keep at -10F", "dimensions": { "length": "48", "lengthUnit": "IN", "width": "40", "widthUnit": "IN", "height": "60", "heightUnit": "IN" }, "weight": { "value": "26000", "unit": "LBS" }, "valueAmount": { "value": "48000", "unit": "USD" }, "cargoCharacteristics": { "stackable": false, "hazmat": false, "perishable": true } }, { "handlingUnit": { "unitType": "PALLET", "unitCount": "10" }, "packagingUnit": { "unitType": "CARTON", "unitCount": "400" }, "commodity": "Frozen vegetables", "description": "Mixed vegetable cartons", "dimensions": { "length": "48", "lengthUnit": "IN", "width": "40", "widthUnit": "IN", "height": "48", "heightUnit": "IN" }, "weight": { "value": "16000", "unit": "LBS" }, "valueAmount": { "value": "12000", "unit": "USD" }, "cargoCharacteristics": { "stackable": true, "hazmat": false, "perishable": true } } ] }, "loadRequirements": { "mode": "FTL", "loadType": "SPOT", "equipment": { "equipmentType": "REEFER", "size": "53", "unit": "FT" }, "temperatureRequirement": { "required": true, "hasBulkhead": false, "zones": [ { "zoneId": "Z1", "minTemp": { "value": -10, "unit": "F" }, "maxTemp": { "value": 0, "unit": "F" } } ] }, "additionalRequiredServices": [ "TEAM_DRIVER" ] }, "rates": { "baseRate": "1850.00", "lineHaul": "1700.00", "accessorials": [ { "type": "FUEL_SURCHARGE", "rate": "150.00" } ], "totalRate": "1850.00", "collectionMethod": "PrePaid" }, "documentDates": [ "2026-07-01" ] } } } } }, "responses": { "200": { "description": "Load created successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadDraftCreationResponse" }, "example": { "loadNum": "LOAD-12345", "message": "Load created successfully" } } } } } } }, "/COMPLETED_CALL": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveCompletedCall", "summary": "Completed Call", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an outbound call placed by an Augment agent ends. `contact` is the person who was called, and `summary`, `callStatus`, `callType`, `outcome`, and `actionItems` describe how the call went.\n\nThis event reports the call itself. It is not a tracking update — when a check-in call yields a location or ETA, that arrives separately as `TRACKING_UPDATE`.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedCallEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDF", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "COMPLETED_CALL", "data": { "callId": "01HZXK9P7QM3N8YV4TBWJC2RDF", "direction": "OUTBOUND", "contact": { "name": "Jane Dispatcher", "externalId": "CONTACT-123", "email": "dispatch@carrier.com", "phone": "+15551234567", "phoneExtension": "204", "role": "DISPATCHER" }, "summary": "Driver confirmed pickup and is en route to delivery.", "callStatus": "CONNECTED", "callType": "CHECK_IN", "outcome": "IN_TRANSIT", "actionItems": [ "Follow up if driver has not arrived by 16:00." ], "analysisStatus": "COMPLETED", "timestamp": "2026-05-13T12:34:56Z", "loadDetails": [ { "loadNumber": "LOAD-456", "loadStatus": "IN_TRANSIT", "driverLocationCity": "Dallas", "driverLocationState": "TX", "driverLocationCountry": "US", "driverLocationLatitude": 32.7767, "driverLocationLongitude": -96.797, "driverEta": "2026-05-13T16:00:00Z" } ] } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/COMPLETED_INBOUND_CALL": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveCompletedInboundCall", "summary": "Completed Inbound Call", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an inbound call handled by an Augment agent ends — the carrier called in rather than being called. The payload is identical to `COMPLETED_CALL` apart from `direction`, which is always `INBOUND`.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompletedInboundCallEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDG", "workflow": "CARRIER_SUPPORT", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "COMPLETED_INBOUND_CALL", "data": { "callId": "01HZXKA2R5T7W9XB3NCEYD6FGH", "direction": "INBOUND", "contact": { "name": "Jane Dispatcher", "externalId": "CONTACT-123", "email": "dispatch@carrier.com", "phone": "+15551234567", "phoneExtension": null, "role": "DISPATCHER" }, "summary": "Carrier called to report a two-hour delay at pickup.", "callStatus": "CONNECTED", "callType": "INBOUND", "outcome": "DELAYED", "actionItems": [ "Notify customer of revised pickup time." ], "analysisStatus": "COMPLETED", "timestamp": "2026-05-13T12:34:56Z", "loadDetails": [ { "loadNumber": "LOAD-456", "loadStatus": "AT_PICKUP", "driverEta": "2026-05-13T14:30:00Z" } ] } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/CALL_RECORDING_AVAILABLE": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveCallRecordingAvailable", "summary": "Call Recording Available", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: `CALL_RECORDING_AVAILABLE` (flat payload).\n\nSent when a signed, time-limited link to download a completed call's recording becomes available. This event only fires for calls that have a recording, and `data.recording` is populated on every delivery.\n\n`recording.downloadUrl` is valid for up to 1 hour from when this event is sent. Check `recording.expiresAt` and fetch the recording well before that time — once it expires the link stops working and cannot be reissued for this event.\n\n`customerLoadInternalId` on this event depends on your TMS integration supplying an internal identifier for the load; it is not guaranteed to be populated for every load.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallRecordingAvailableEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDH", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:40:00Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "CALL_RECORDING_AVAILABLE", "data": { "callId": "01HZXK9P7QM3N8YV4TBWJC2RDF", "direction": "OUTBOUND", "callStatus": "COMPLETED", "timestamp": "2026-05-13T12:34:56Z", "contact": { "name": "Jane Dispatcher", "phone": "+15551234567", "phoneExtension": "204", "role": "DISPATCHER" }, "recording": { "downloadUrl": "https://d2fx6kyxfjkkep.cloudfront.net/recordings/call_01HZXK9P7QM3N8YV4TBWJC2RDF?Expires=1789500000&Signature=EXAMPLE&Key-Pair-Id=APKAEXAMPLE123", "expiresAt": "2026-05-13T13:34:56Z" } } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/NEW_EMAIL": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveNewEmail", "summary": "New Email", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an inbound email relating to one of your loads is received by an Augment agent. `participants` and `subject` identify the email, while `summary` and `classification` describe what it was about.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEmailEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDH", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "NEW_EMAIL", "data": { "direction": "INBOUND", "attachmentCount": 1, "participants": { "from": { "name": "Jane Dispatcher", "address": "dispatch@carrier.com" }, "to": [ { "name": "Augment", "address": "loads@augment.example" } ], "cc": [] }, "subject": "RE: LOAD-456 delivery update", "summary": "Carrier reports delivery completed at 14:05.", "classification": "DELIVERY_UPDATE" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/NEW_REP_EMAIL": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveNewRepEmail", "summary": "New Rep Email", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an inbound email from one of your own reps is received by an Augment agent. Same payload as `NEW_EMAIL`; the separate event type lets you distinguish correspondence with your team from correspondence with carriers.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRepEmailEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDJ", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "NEW_REP_EMAIL", "data": { "direction": "INBOUND", "attachmentCount": 0, "participants": { "from": { "name": "Sam Rep", "address": "sam@brokerage.example" }, "to": [ { "name": "Augment", "address": "loads@augment.example" } ], "cc": [] }, "subject": "RE: LOAD-456 — please stop tracking", "summary": "Rep asks the agent to pause outreach on this load.", "classification": "GENERAL_INQUIRY" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/SENT_EMAIL": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveSentEmail", "summary": "Sent Email", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an Augment agent sends an email on one of your loads. `participants` and `subject` identify the email that went out.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentEmailEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDK", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "SENT_EMAIL", "data": { "direction": "OUTBOUND", "attachmentCount": 0, "participants": { "from": { "name": "Augment", "address": "loads@augment.example" }, "to": [ { "name": "Jane Dispatcher", "address": "dispatch@carrier.com" } ], "cc": [] }, "subject": "LOAD-456 — checking in on pickup" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/RECEIVED_EXTERNAL_TEXT_MESSAGE": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveReceivedExternalTextMessage", "summary": "Received Text Message", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an inbound text message relating to one of your loads is received by an Augment agent. `message` carries the text, while `summary` and `classification` describe what it was about.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceivedExternalTextMessageEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDM", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "RECEIVED_EXTERNAL_TEXT_MESSAGE", "data": { "direction": "INBOUND", "message": "Running about an hour behind, hitting traffic on I-80.", "summary": "Driver reports a one-hour delay due to traffic.", "classification": "LOAD_TRACKING" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/SENT_EXTERNAL_TEXT_MESSAGE": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveSentExternalTextMessage", "summary": "Sent Text Message", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an Augment agent sends a text message on one of your loads.\n\nThis event records that the message was sent, not that it reached the handset. The envelope's `occurredAt` is when Augment sent it.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SentExternalTextMessageEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDN", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "SENT_EXTERNAL_TEXT_MESSAGE", "data": { "direction": "OUTBOUND", "message": "Hi Jane, checking in on LOAD-456 — any update on ETA?", "contactType": "CarrierContact", "contact": { "name": "Jane Dispatcher", "externalId": "CONTACT-123", "email": "dispatch@carrier.com", "phone": "+15551234567", "phoneExtension": null }, "attachmentCount": 0 } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/WORKFLOW_STATUS_UPDATE": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveWorkflowStatusUpdate", "summary": "Workflow Status Update", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an Augment agent workflow on one of your loads changes state — for example when it completes, is canceled, escalates to a human, or errors. Use it to mirror agent progress in your TMS.\n\n`statusReasonCode` is free-form and workflow-specific; treat it as an open set and do not branch on values you have not agreed with Augment.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowStatusUpdateEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDP", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "WORKFLOW_STATUS_UPDATE", "data": { "status": "ESCALATED", "agent": "TRACK_AND_TRACE_AGENT", "context": "Carrier unreachable after three attempts.", "statusReasonCode": "MISSING_CONTACT_INFO" } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/HUMAN_ASSISTANCE_REQUESTED": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveHumanAssistanceRequested", "summary": "Human Assistance Requested", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when an Augment agent hands a load off to a human. `contact` is the person at your brokerage the agent routed the request to, so you can surface the handoff to the right queue or rep.\n\n`reasonCode` says why the agent could not continue on its own.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HumanAssistanceRequestedEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDQ", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "HUMAN_ASSISTANCE_REQUESTED", "data": { "reasonCode": "INSUFFICIENT_INFORMATION", "contact": { "name": "Sam Rep", "externalId": "REP-123", "email": "sam@brokerage.example", "phone": "+15559876543", "phoneExtension": null } } } } } }, "responses": { "200": { "description": "Event acknowledged" } } } }, "/CANCELED_SCHEDULED_OUTREACH": { "post": { "tags": [ "Agent Activity" ], "operationId": "receiveCanceledScheduledOutreach", "summary": "Canceled Scheduled Outreach", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "> v1 equivalent: none. v2 only.\n\nSent when a carrier outreach that Augment had scheduled is canceled before it ran. The `data` payload describes the outreach that was canceled and is the same shape as `SCHEDULED_CARRIER_OUTREACH`, so you can match it against the outreach you recorded earlier. `occurredAt` is when the cancellation happened; `scheduledAt` is when the outreach would have run.\n\nSent only for outreach directed at a contact — a call, email, or text that will now not happen.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CanceledScheduledOutreachEvent" }, "example": { "id": "evt_01HZXK9P7QM3N8YV4TBWJC2RDR", "workflow": "TRACK_AND_TRACE", "occurredAt": "2026-05-13T12:34:56Z", "loadNumber": "LOAD-456", "customerLoadInternalId": "INT-789", "eventType": "CANCELED_SCHEDULED_OUTREACH", "data": { "scheduledAt": "2026-05-14T08:00:00Z", "outreachType": "PHONE_CALL", "context": "Follow up on delivery ETA" } } } } } } }, "/PURCHASE_ORDER_UPDATE": { "post": { "tags": [ "Purchase Order Management" ], "operationId": "receivePurchaseOrderUpdate", "summary": "Purchase Order Update", "x-badges": [ { "name": "Optional", "color": "#64748b" } ], "description": "Sent when a supplier gives us new expected dates for a purchase order, so your system can update the promise dates it holds. One event per update, scoped to the purchase order, with the affected lines nested.\n\nDates appear at the level the supplier stated them: on the purchase order when the supplier gave one date for the whole order, on `lineItems` when the supplier spoke line by line. Only lines that have a new date appear, and an update that carries no new date sends no event.\n\n`note` carries what the typed fields cannot — the supplier's wording for why a date moved. It is present at both levels.\n\nFailed deliveries are retried with exponential backoff, so the same update can arrive more than once — including after your handler applied it, when the `200` did not reach Augment. `purchaseOrderNumber` plus `collectedAt` identifies one update: treat a repeat of that pair as the delivery you have already applied.\n\nToday this event carries expected dates only. What Augment learns that is not a date — cancellations, no record of the purchase order, shipped and delivered confirmations, tracking numbers — is not sent on this event.\n", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdate" }, "example": { "purchaseOrderNumber": "PO-1001", "expectedShipDate": null, "expectedArrivalDate": null, "note": "2 units of RH110 backordered until late September.", "lineItems": [ { "identifier": "RH110", "expectedShipDate": "2026-09-25", "expectedArrivalDate": null, "note": "Due into supplier late September." } ], "source": "SUPPLIER_EMAIL", "collectedAt": "2026-08-23T18:04:00Z" } } } }, "responses": { "200": { "description": "Event acknowledged" } } } } }, "components": { "schemas": { "LoadFileUploadRequest": { "type": "object", "required": [ "loadNum", "filename", "fileType", "contentType", "content", "sizeBytes", "checksum" ], "properties": { "loadNum": { "type": "string", "description": "The load's external number in the TMS (brokerageLoadId)" }, "internalLoadReference": { "type": "string", "description": "Optional internal load identifier from the TMS (customerLoadInternalId). Only included when available." }, "filename": { "type": "string", "description": "Original filename including extension. Supported extensions: `.pdf`, `.jpg`, `.jpeg`, `.png`, `.heic`, `.webp`, `.tiff`, `.tif`", "examples": [ "invoice-1234.pdf" ] }, "fileType": { "$ref": "#/components/schemas/LoadFileType" }, "contentType": { "type": "string", "description": "MIME type of the file. Supported values: `application/pdf`, `image/jpeg`, `image/png`, `image/heic`, `image/webp`, `image/tiff`", "examples": [ "application/pdf" ] }, "content": { "type": "string", "description": "Base64-encoded file bytes" }, "sizeBytes": { "type": "integer", "description": "File size in bytes" }, "checksum": { "type": "string", "description": "MD5 hex digest of the raw (pre-encoding) file bytes, used for integrity verification" }, "referenceNumbers": { "$ref": "#/components/schemas/LoadFileUploadReferenceNumbers" }, "source": { "$ref": "#/components/schemas/LoadFileUploadSource", "description": "Origin of the document, used by some brokerages for routing (e.g. carrier ID)" }, "createdAt": { "type": "string", "description": "ISO 8601 timestamp of when the document was collected/created" } } }, "BatchFileUploadResponse": { "type": "object", "required": [ "summary", "results" ], "properties": { "summary": { "$ref": "#/components/schemas/FileUploadSummary" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FileUploadResult" } } } }, "ApiErrorBody": { "type": "object", "required": [ "message" ], "x-property-order": [ "message", "errorCode", "details" ], "properties": { "message": { "type": "string", "description": "An error message" }, "errorCode": { "type": "string", "description": "An error code" }, "details": { "oneOf": [ { "type": "object" }, { "type": "string" } ], "description": "Additional error details" } } }, "BidCreated": { "type": "object", "description": "Carrier interest or a carrier bid submitted for a load. Delivered via PUSH_BID_TO_TMS webhook subscription. This callback is sent when a carrier expresses interest, even if the carrier did not provide a dollar offer amount.\n", "required": [ "bidId", "createdAt", "loadReference", "internalLoadReference", "carrier", "channel", "truckEmpty" ], "x-property-order": [ "bidId", "createdAt", "loadReference", "internalLoadReference", "carrier", "offerAmount", "channel", "truckEmpty", "repId" ], "properties": { "bidId": { "type": "string", "description": "Unique identifier for the bid", "example": "bid-abc-123" }, "createdAt": { "type": "string", "format": "date-time", "description": "UTC ISO 8601 timestamp ending in `Z` of when the bid was created.\n", "example": "2026-02-19T14:30:00.000Z" }, "loadReference": { "type": "string", "description": "Brokerage load reference number", "example": "LOAD-456" }, "internalLoadReference": { "type": "string", "description": "Augment internal load reference", "example": "INT-789" }, "carrier": { "type": "object", "description": "Carrier that submitted the bid. At least one of `id`, `mcNumber`, or `dotNumber` must be present.\n", "anyOf": [ { "required": [ "id" ] }, { "required": [ "mcNumber" ] }, { "required": [ "dotNumber" ] } ], "properties": { "id": { "type": [ "string", "null" ], "description": "Carrier identifier", "example": "carrier-001" }, "mcNumber": { "type": [ "number", "null" ], "description": "Carrier MC number", "example": 123456 }, "dotNumber": { "type": [ "number", "null" ], "description": "Carrier DOT number", "example": 7890123 } } }, "offerAmount": { "type": [ "number", "null" ], "description": "Bid offer amount in dollars. This can be null when the carrier expressed interest but did not provide a dollar amount.", "example": 2500 }, "channel": { "type": "object", "description": "Communication channel used for the bid. At least one of `phone` or `email` must be present.\n", "required": [ "type" ], "anyOf": [ { "required": [ "phone" ] }, { "required": [ "email" ] } ], "properties": { "type": { "type": "string", "enum": [ "call", "email" ], "description": "Type of communication channel", "example": "call" }, "phone": { "type": [ "string", "null" ], "description": "Phone number (present for call-based bids)", "example": "+15551234567" }, "email": { "type": [ "string", "null" ], "format": "email", "description": "Email address (present for email-based bids)" } } }, "truckEmpty": { "type": "object", "description": "Truck empty location and availability", "properties": { "city": { "type": [ "string", "null" ], "description": "City name", "example": "Dallas" }, "stateOrProvince": { "type": [ "string", "null" ], "description": "State or province code", "example": "TX" }, "country": { "type": [ "string", "null" ], "enum": [ "US", "CA", "MX", null ], "description": "Country code", "example": "US" }, "dateTime": { "type": [ "string", "null" ], "format": "date-time", "description": "Truck empty date and time", "example": "2026-02-20T08:00:00.000Z" } } }, "repId": { "type": [ "string", "null" ], "description": "Augment representative ID who facilitated the bid", "example": "rep-456" } } }, "LoadDraftPayload": { "type": "object", "description": "Load draft payload containing all information needed to create a load in the TMS.\n", "required": [ "loadDraftId" ], "properties": { "loadDraftId": { "type": "string", "description": "Stable identifier for this load draft, assigned by Augment. Present on every LOAD_DRAFT event and used to correlate the draft with subsequent updates.\n" }, "referenceNumbers": { "type": "object", "description": "Customer reference numbers associated with the load.", "properties": { "shipmentNumber": { "type": "string", "description": "Shipment number" }, "customerReferenceNumber": { "type": "string", "description": "Customer reference number" }, "customerLoadNumber": { "type": "string", "description": "Customer load number" }, "releaseNumber": { "type": "string", "description": "Release number" }, "bolNumber": { "type": "string", "description": "Bill of lading number" }, "poNumber": { "type": "string", "description": "Purchase order number" }, "proNumber": { "type": "string", "description": "PRO number" }, "driverNumber": { "type": "string", "description": "Driver number" }, "tractorNumber": { "type": "string", "description": "Tractor number" }, "trailerNumber": { "type": "string", "description": "Trailer number" }, "others": { "type": "array", "description": "Additional reference numbers not covered by named fields", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Reference number type label" }, "value": { "type": "string", "description": "Reference number value" } } } } } }, "customerInformation": { "type": "object", "description": "Shipper and billing information.", "properties": { "name": { "type": "string", "description": "Customer name" }, "contact": { "type": "object", "description": "Customer contact information", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } } }, "address": { "type": "object", "description": "Customer billing address", "properties": { "name": { "type": "string", "description": "Location name" }, "streetAddress": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "US" } } }, "notes": { "type": "string", "description": "Customer-facing notes" }, "internalNotes": { "type": "string", "description": "Internal operational notes" }, "shipperId": { "type": "string", "description": "Shipper identifier" }, "divisionTerm": { "type": "string", "description": "Division or billing term associated with the customer" } } }, "stops": { "type": "array", "description": "Ordered list of pickup and delivery stops on the load.", "items": { "type": "object", "properties": { "stopNumber": { "type": "integer", "description": "1-based stop sequence number" }, "stopType": { "type": "string", "enum": [ "PICKUP", "DELIVERY" ], "description": "Whether the stop is a pickup or delivery" }, "referenceNumber": { "type": "string", "description": "Stop-level reference number" }, "facilityName": { "type": "string", "description": "Name of the facility" }, "facilityCode": { "type": "string", "description": "Facility code, if known" }, "facilityAddress": { "type": "object", "description": "Address of the facility", "properties": { "name": { "type": "string", "description": "Location name" }, "streetAddress": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "US" } } }, "facilityContact": { "type": "object", "description": "Contact information for the facility", "properties": { "email": { "type": "string" }, "phone": { "type": "string" } } }, "handlingType": { "type": "string", "enum": [ "LIVE", "DROP_TRAILER" ], "description": "Load/unload handling type for the stop" }, "appointmentType": { "type": "string", "enum": [ "APPOINTMENT", "FIRST_COME_FIRST_SERVE" ], "description": "Scheduling method for the stop" }, "appointmentTime": { "type": "object", "description": "Scheduled appointment window", "properties": { "start": { "type": "string", "description": "Appointment start as a UTC ISO 8601 timestamp ending in `Z`." }, "end": { "type": "string", "description": "Appointment end as a UTC ISO 8601 timestamp ending in `Z`." }, "timezone": { "type": "string", "description": "IANA timezone identifier" } } }, "dropTime": { "type": "object", "description": "Drop time window for drop-trailer stops", "properties": { "start": { "type": "string", "description": "Drop window start as a UTC ISO 8601 timestamp ending in `Z`." }, "end": { "type": "string", "description": "Drop window end as a UTC ISO 8601 timestamp ending in `Z`." }, "timezone": { "type": "string", "description": "IANA timezone identifier" } } }, "driverInstructions": { "type": "string", "description": "Special instructions for the driver at this stop" }, "notes": { "type": "string", "description": "Customer-facing notes for the stop" }, "internalNotes": { "type": "string", "description": "Internal operational notes for the stop" }, "shippingHours": { "type": "string", "description": "Shipping hours for the facility" }, "receivingHours": { "type": "string", "description": "Receiving hours for the facility" }, "operatingHours": { "type": "string", "description": "General operating hours for the facility" }, "timezone": { "type": "string", "description": "IANA timezone identifier for the facility's local time" } } } }, "loadDetails": { "type": "object", "description": "Commodity and cargo details. The fields on this object describe the load as a whole. When the source supplies per-line detail, `cargoItems` carries it and these top-level fields act as the summary for the load. Augment passes both through exactly as supplied and does not derive or reconcile them, so do not assume the summary equals the sum of `cargoItems`.\n", "properties": { "handlingUnit": { "type": "object", "description": "Handling unit information (e.g. pallets)", "properties": { "unitType": { "type": "string", "enum": [ "PALLET", "PIECE", "CARTON", "TOTE", "SKID", "CRATE", "BOX", "DRUM", "CASE", "FLOOR_LOADED", "ROLL", "SHEET" ], "description": "Type of handling unit" }, "unitCount": { "type": "string", "description": "Number of handling units" } } }, "packagingUnit": { "type": "object", "description": "Packaging unit information (e.g. cartons inside pallets)", "properties": { "unitType": { "type": "string", "enum": [ "PALLET", "PIECE", "CARTON", "TOTE", "SKID", "CRATE", "BOX", "DRUM", "CASE", "FLOOR_LOADED", "ROLL", "SHEET" ], "description": "Type of packaging unit" }, "unitCount": { "type": "string", "description": "Number of packaging units" } } }, "commodity": { "type": "string", "description": "Commodity description (typically 40 characters or fewer)" }, "description": { "type": "string", "description": "Extended commodity description" }, "dimensions": { "type": "object", "description": "Load dimensions", "properties": { "length": { "type": "string" }, "lengthUnit": { "type": "string", "example": "IN" }, "width": { "type": "string" }, "widthUnit": { "type": "string", "example": "IN" }, "height": { "type": "string" }, "heightUnit": { "type": "string", "example": "IN" }, "volume": { "type": "string" }, "volumeUnit": { "type": "string", "example": "CUFT" } } }, "weight": { "type": "object", "description": "Total load weight", "properties": { "value": { "type": "string" }, "unit": { "type": "string", "example": "LBS" } } }, "valueAmount": { "type": "object", "description": "Declared value of the load", "properties": { "value": { "type": "string" }, "unit": { "type": "string", "example": "USD" } } }, "cargoCharacteristics": { "type": "object", "properties": { "stackable": { "type": "boolean", "description": "Whether cargo can be stacked" }, "hazmat": { "type": "boolean", "description": "Whether cargo contains hazardous materials" }, "perishable": { "type": "boolean", "description": "Whether cargo is perishable or temperature-sensitive" }, "hazardousDetails": { "type": "object", "description": "Details of the hazardous material being transported. Populated only when `hazmat` is true.\n", "properties": { "name": { "type": "string", "description": "Hazardous material name" }, "nameQualifier": { "type": "string", "description": "Qualifier for the hazardous material name" }, "unCode": { "type": "string", "description": "UN/NA identification code" }, "contact": { "type": "string", "description": "Emergency contact name" }, "number": { "type": "string", "description": "Emergency contact phone number" }, "hazardClass": { "type": "string", "description": "Hazard class" }, "placardsNeeded": { "type": "string", "description": "Placards required for transport" }, "placardNumber": { "type": "string", "description": "Placard number" }, "packingGroup": { "type": "string", "description": "Packing group" }, "flashpointTemp": { "type": "string", "description": "Flashpoint temperature" }, "controlTemp": { "type": "string", "description": "Control temperature" }, "emergencyTemp": { "type": "string", "description": "Emergency temperature" }, "tempQualifier": { "type": "string", "description": "Unit or qualifier for the temperature values" } } } } }, "freightClass": { "type": "string", "enum": [ "50", "55", "60", "65", "70", "77.5", "85", "92.5", "100", "110", "125", "150", "175", "200", "250", "300", "400", "500" ], "description": "NMFC freight class used for LTL rating. Sent as a string.", "example": "70" }, "nmfc": { "type": "string", "description": "NMFC item number, as given on the tender (e.g. 149980 or 149980-02).", "example": "149980-02" }, "cargoItems": { "type": "array", "description": "Per-line cargo detail. Each entry uses the same fields as the summary above and describes a single line. Present only when the source supplied per-line detail — some sources populate the summary fields only, so an absent or empty `cargoItems` does not by itself mean the load carries a single commodity.\n", "items": { "type": "object", "properties": { "handlingUnit": { "type": "object", "description": "Handling unit information (e.g. pallets)", "properties": { "unitType": { "type": "string", "enum": [ "PALLET", "PIECE", "CARTON", "TOTE", "SKID", "CRATE", "BOX", "DRUM", "CASE", "FLOOR_LOADED", "ROLL", "SHEET" ], "description": "Type of handling unit" }, "unitCount": { "type": "string", "description": "Number of handling units" } } }, "packagingUnit": { "type": "object", "description": "Packaging unit information (e.g. cartons inside pallets)", "properties": { "unitType": { "type": "string", "enum": [ "PALLET", "PIECE", "CARTON", "TOTE", "SKID", "CRATE", "BOX", "DRUM", "CASE", "FLOOR_LOADED", "ROLL", "SHEET" ], "description": "Type of packaging unit" }, "unitCount": { "type": "string", "description": "Number of packaging units" } } }, "commodity": { "type": "string", "description": "Commodity description (typically 40 characters or fewer)" }, "description": { "type": "string", "description": "Extended commodity description" }, "dimensions": { "type": "object", "description": "Cargo item dimensions", "properties": { "length": { "type": "string" }, "lengthUnit": { "type": "string", "example": "IN" }, "width": { "type": "string" }, "widthUnit": { "type": "string", "example": "IN" }, "height": { "type": "string" }, "heightUnit": { "type": "string", "example": "IN" }, "volume": { "type": "string" }, "volumeUnit": { "type": "string", "example": "CUFT" } } }, "weight": { "type": "object", "description": "Weight of this cargo item", "properties": { "value": { "type": "string" }, "unit": { "type": "string", "example": "LBS" } } }, "valueAmount": { "type": "object", "description": "Declared value of the cargo item", "properties": { "value": { "type": "string" }, "unit": { "type": "string", "example": "USD" } } }, "cargoCharacteristics": { "type": "object", "properties": { "stackable": { "type": "boolean", "description": "Whether cargo can be stacked" }, "hazmat": { "type": "boolean", "description": "Whether cargo contains hazardous materials" }, "perishable": { "type": "boolean", "description": "Whether cargo is perishable or temperature-sensitive" }, "hazardousDetails": { "type": "object", "description": "Details of the hazardous material being transported. Populated only when `hazmat` is true.\n", "properties": { "name": { "type": "string", "description": "Hazardous material name" }, "nameQualifier": { "type": "string", "description": "Qualifier for the hazardous material name" }, "unCode": { "type": "string", "description": "UN/NA identification code" }, "contact": { "type": "string", "description": "Emergency contact name" }, "number": { "type": "string", "description": "Emergency contact phone number" }, "hazardClass": { "type": "string", "description": "Hazard class" }, "placardsNeeded": { "type": "string", "description": "Placards required for transport" }, "placardNumber": { "type": "string", "description": "Placard number" }, "packingGroup": { "type": "string", "description": "Packing group" }, "flashpointTemp": { "type": "string", "description": "Flashpoint temperature" }, "controlTemp": { "type": "string", "description": "Control temperature" }, "emergencyTemp": { "type": "string", "description": "Emergency temperature" }, "tempQualifier": { "type": "string", "description": "Unit or qualifier for the temperature values" } } } } }, "freightClass": { "type": "string", "enum": [ "50", "55", "60", "65", "70", "77.5", "85", "92.5", "100", "110", "125", "150", "175", "200", "250", "300", "400", "500" ], "description": "NMFC freight class used for LTL rating. Sent as a string.", "example": "70" }, "nmfc": { "type": "string", "description": "NMFC item number, as given on the tender (e.g. 149980 or 149980-02).", "example": "149980-02" } } } } } }, "loadRequirements": { "type": "object", "description": "Equipment and service requirements.", "properties": { "mode": { "type": "string", "enum": [ "FTL", "LTL", "DRAYAGE" ], "description": "Transportation mode" }, "loadType": { "type": "string", "enum": [ "SPOT", "CONTRACT", "DEDICATED", "PROJECT" ], "description": "Rate type / load type" }, "equipment": { "type": "object", "description": "Equipment requirements", "properties": { "equipmentType": { "type": "string", "enum": [ "DRY_VAN", "FLATBED", "REEFER", "CONTAINER", "CONESTOGA", "CONTAINERS", "DECKS_SPECIALIZED", "DECKS_STANDARD", "DRY_BULK", "FLATBEDS", "HAZARDOUS_MATERIALS", "OTHER_EQUIPMENT", "REEFERS", "TANKERS", "VANS_SPECIALIZED", "VANS_STANDARD", "AUTO_CARRIER", "B_TRAIN", "CONTAINER_INSULATED", "CONTAINER_REFRIGERATED", "CONVEYOR", "DOUBLE_DROP", "DUMP_TRAILER", "DROP_DECK_LANDOLL", "FLATBED_AIR_RIDE", "FLATBED_CONESTOGA", "FLATBED_DOUBLE", "FLATBED_HAZMAT", "FLATBED_HOTSHOT", "FLATBED_MAXI", "FLATBED_OR_STEP_DECK", "FLATBED_OVERDIMENSION", "FLATBED_VAN_REEFER", "FLATBED_WITH_CHAINS", "FLATBED_WITH_SIDES", "FLATBED_WITH_TARPS", "FLATBED_WITH_TEAM", "HOPPER_BOTTOM", "INSULATED_VAN_OR_REEFER", "LOWBOY", "LOWBOY_OR_REM_GOOSENECK_RGN", "LOWBOY_OVERDIMENSION", "MOVING_VAN", "OTHER", "PNEUMATIC", "POWER_ONLY", "POWER_ONLY_LOAD_OUT", "POWER_ONLY_TOW_AWAY", "REEFER_AIR_RIDE", "REEFER_DOUBLE", "REEFER_HAZMAT", "REEFER_INTERMODAL", "REEFER_LOGISTICS", "REEFER_OR_VENTED_VAN", "REEFER_PALLET_EXCHANGE", "REEFER_WITH_TEAM", "REMOVABLE_GOOSENECK", "SPRINTER_VAN", "SPRINTER_VAN_HAZMAT", "SPRINTER_VAN_TEMP_CONTROLLED", "SPRINTER_VAN_WITH_TEAM", "STEP_DECK", "STEP_DECK_OR_REM_GOOSENECK_RGN", "STEPDECK_CONESTOGA", "STRAIGHT_BOX_TRUCK", "STRAIGHT_BOX_TRUCK_HAZMAT", "STRAIGHT_BOX_TRUCK_REEFER", "STRETCH_TRAILER", "TANKER_ALUMINUM", "TANKER_INTERMODAL", "TANKER_STEEL", "TRUCK_AND_TRAILER", "VAN", "VAN_AIR_RIDE", "VAN_BLANKET_WRAP", "VAN_CONESTOGA", "VAN_DOUBLE", "VAN_HOTSHOT", "VAN_INSULATED", "VAN_INTERMODAL", "VAN_LIFT_GATE", "VAN_LOGISTICS", "VAN_OPEN_TOP", "VAN_OR_FLATBED", "VAN_OR_FLATBED_WITH_TARPS", "VAN_OR_REEFER", "VAN_PALLET_EXCHANGE", "VAN_ROLLER_BED", "VAN_TRIPLE", "VAN_VENTED", "VAN_WITH_CURTAINS", "VAN_WITH_TEAM", "VAN_HAZMAT", "HOTSHOT_FLATBED", "STRAIGHT_TRUCK", "VAN_SPRINTER", "REMOVABLE_GOOSE_NECK", "TANKER", "BOX_TRUCK" ], "description": "Equipment type" }, "size": { "type": "string", "description": "Equipment size (e.g. 53)" }, "unit": { "type": "string", "description": "Unit of measure for equipment size" } } }, "additionalRequiredServices": { "type": "array", "items": { "type": "string" }, "description": "Additional services required for the load (e.g. liftgate, team driver)" }, "tarpSize": { "type": [ "string", "null" ], "description": "Tarp size required, if applicable" }, "temperatureRequirement": { "type": [ "object", "null" ], "description": "Temperature control requirements", "properties": { "required": { "type": "boolean", "description": "Whether temperature control is required" }, "hasBulkhead": { "type": "boolean", "description": "Whether a bulkhead is required" }, "zones": { "type": "array", "description": "Temperature zones for multi-zone reefer loads", "items": { "type": "object", "properties": { "zoneId": { "type": "string", "description": "Zone identifier" }, "minTemp": { "type": [ "object", "null" ], "description": "Minimum temperature", "properties": { "value": { "type": "number" }, "unit": { "type": "string", "enum": [ "F", "C" ] } } }, "maxTemp": { "type": [ "object", "null" ], "description": "Maximum temperature", "properties": { "value": { "type": "number" }, "unit": { "type": "string", "enum": [ "F", "C" ] } } } } } } } } } }, "rates": { "type": "object", "description": "Pricing information for the load.", "properties": { "baseRate": { "type": "string", "description": "Base rate in dollars" }, "lineHaul": { "type": "string", "description": "Line haul rate in dollars" }, "accessorials": { "type": "array", "description": "Accessorial charges", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "Accessorial charge type" }, "rate": { "type": "string", "description": "Accessorial charge amount in dollars" } } } }, "totalRate": { "type": "string", "description": "Total rate in dollars" }, "collectionMethod": { "type": "string", "enum": [ "PrePaid", "Collect", "ThirdParty", "CollectOnDelivery" ], "description": "Payment collection method" } } }, "documentDates": { "type": "array", "items": { "type": "string" }, "description": "ISO 8601 date strings associated with documents on the load (e.g. BOL date, delivery date)\n" } } }, "LoadDraftCreationResponse": { "type": "object", "description": "Response returned by the TMS after creating a load from a draft. The `loadNum` field must be present.\n", "required": [ "loadNum" ], "properties": { "loadNum": { "type": "string", "description": "The load number assigned by the TMS to the newly created load. This is the primary identifier used to link the Augment load draft to the TMS load.\n", "example": "LOAD-12345" }, "message": { "type": "string", "description": "Optional success or error message from the TMS describing the result of the load creation.\n", "example": "Load created successfully" }, "referenceNumbers": { "type": "object", "description": "Optional reference numbers returned by the TMS (e.g. load number, customer order number, trace IDs).\n", "properties": { "shipmentNumber": { "type": "string" }, "customerReferenceNumber": { "type": "string" }, "customerLoadNumber": { "type": "string" }, "releaseNumber": { "type": "string" }, "bolNumber": { "type": "string" }, "poNumber": { "type": "string" }, "proNumber": { "type": "string" }, "driverNumber": { "type": "string" }, "tractorNumber": { "type": "string" }, "trailerNumber": { "type": "string" }, "others": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "value": { "type": "string" } } } } } } } }, "LoadFileType": { "type": "string", "enum": [ "INVOICE", "POD", "BOL", "RATE_CONFIRMATION", "LUMPER_RECEIPT", "OTHER" ], "description": "The category of the document being uploaded" }, "LoadFileUploadReferenceNumbers": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Required when fileType is INVOICE" } } }, "LoadFileUploadSource": { "type": "object", "description": "Origin of the uploaded document (e.g. a carrier or driver)", "required": [ "type", "identifierType", "identifier" ], "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/LoadFileSourceType", "description": "The kind of entity that provided the document" }, "identifierType": { "$ref": "#/components/schemas/LoadFileSourceIdentifierType", "description": "How the source entity is identified" }, "identifier": { "type": "string", "description": "The identifier value (e.g. MC number, SCAC code, email address)" }, "name": { "type": "string", "description": "Optional display name for the source entity" } } }, "FileUploadSummary": { "type": "object", "required": [ "total", "succeeded", "failed" ], "properties": { "total": { "type": "integer", "description": "Total number of files submitted" }, "succeeded": { "type": "integer", "description": "Number of files successfully uploaded" }, "failed": { "type": "integer", "description": "Number of files that failed to upload" } } }, "FileUploadResult": { "oneOf": [ { "$ref": "#/components/schemas/FileUploadSuccess" }, { "$ref": "#/components/schemas/FileUploadFailure" } ], "discriminator": { "propertyName": "success" } }, "LoadFileSourceType": { "type": "string", "enum": [ "CARRIER", "BROKER", "SHIPPER", "CONSIGNEE", "DRIVER", "OTHER" ], "description": "The kind of entity that provided the document" }, "LoadFileSourceIdentifierType": { "type": "string", "enum": [ "MC_NUMBER", "DOT_NUMBER", "SCAC", "EMAIL", "NAME", "EXTERNAL_ID" ], "description": "How the source entity is identified" }, "FileUploadSuccess": { "type": "object", "required": [ "filename", "success", "data" ], "properties": { "filename": { "type": "string" }, "success": { "type": "boolean", "enum": [ true ] }, "data": { "type": "object", "required": [ "size", "contentType" ], "properties": { "size": { "type": "integer", "description": "Size of the uploaded file in bytes" }, "contentType": { "type": "string", "description": "MIME type of the uploaded file" }, "id": { "type": "string", "description": "ID assigned to the document by the TMS, if available" } } } } }, "FileUploadFailure": { "type": "object", "required": [ "filename", "success", "error" ], "properties": { "filename": { "type": "string" }, "success": { "type": "boolean", "enum": [ false ] }, "error": { "type": "string", "description": "Error message describing why the upload failed" } } }, "EventEnvelope": { "type": "object", "description": "Fields present on every v2 webhook event.", "required": [ "id", "workflow", "occurredAt", "loadNumber", "customerLoadInternalId" ], "x-property-order": [ "id", "workflow", "occurredAt", "loadNumber", "customerLoadInternalId" ], "properties": { "id": { "type": "string", "description": "Unique event identifier (ULID)" }, "workflow": { "type": [ "string", "null" ], "enum": [ "TRACK_AND_TRACE", "CARRIER_SUPPORT", "POD_COLLECTION", "LOAD_BUILDING", "CARRIER_SELECTION", "SCHEDULING", "CUSTOMER_SUPPORT", null ], "description": "The Augment workflow that produced this event, or `null` when no single workflow can be attributed. New values may be added over time, so treat this as an open set rather than a fixed list.\n" }, "occurredAt": { "type": "string", "format": "date-time", "description": "When the underlying activity occurred (ISO 8601)" }, "loadNumber": { "type": [ "string", "null" ], "description": "Your load reference number" }, "customerLoadInternalId": { "type": [ "string", "null" ], "description": "Your internal load ID, if provided during load creation" } } }, "BidCreatedEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "BID_CREATED" ], "description": "Event name for a carrier bid." }, "data": { "description": "Bid data payload.", "$ref": "#/components/schemas/BidCreated" } } } ] }, "LoadDraftEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "LOAD_DRAFT" ], "description": "Event name for an assembled load draft." }, "data": { "description": "Load draft data payload.", "$ref": "#/components/schemas/LoadDraftPayload" } } } ] }, "UploadDocumentEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "UPLOAD_DOCUMENT" ], "description": "Event name for a document upload." }, "data": { "description": "Document upload data payload. In `multipart/form-data` deliveries, `content` is omitted here and sent as the `content` file part instead.\n", "$ref": "#/components/schemas/LoadFileUploadRequest" } } } ] }, "TransitUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "TRACKING_UPDATE" ], "description": "Event name for a transit update." }, "data": { "description": "Transit update data payload.", "$ref": "#/components/schemas/TrackingEvent" } } } ] }, "StopUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "STOP_UPDATE" ], "description": "Event name for a stop status update." }, "data": { "description": "Stop update data payload.", "$ref": "#/components/schemas/StopUpdate" } } } ] }, "CarrierInfoUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "LOAD_CARRIER_UPDATE" ], "description": "Event name for a carrier information update." }, "data": { "description": "Carrier information update data payload.", "$ref": "#/components/schemas/CarrierUpdate" } } } ] }, "CommentEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "SEND_TMS_COMMENT" ], "description": "Event name for an unstructured communication comment." }, "data": { "description": "Comment data payload.", "$ref": "#/components/schemas/CommunicationData" } } } ] }, "ScheduledCarrierOutreachCallbackResponse": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "SCHEDULED_CARRIER_OUTREACH" ], "description": "Event name for scheduled carrier outreach." }, "data": { "description": "Scheduled carrier outreach data payload.", "$ref": "#/components/schemas/ScheduledCarrierOutreachData" } } } ] }, "ScheduledCarrierOutreachData": { "type": "object", "description": "Details for a future carrier outreach scheduled by Augment.", "required": [ "scheduledAt", "outreachType", "context" ], "x-property-order": [ "scheduledAt", "outreachType", "context" ], "properties": { "scheduledAt": { "type": "string", "format": "date-time", "description": "When the carrier outreach is scheduled to occur, in UTC ISO 8601 format.", "example": "2025-08-21T12:34:56Z" }, "outreachType": { "type": "string", "enum": [ "PHONE_CALL", "EMAIL", "TEXT_MESSAGE" ], "description": "Type of carrier outreach that was scheduled." }, "context": { "type": "string", "description": "Free-text context for the scheduled outreach." } } }, "AppointmentUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "APPOINTMENT_UPDATE" ], "description": "Event name for a stop appointment update." }, "data": { "$ref": "#/components/schemas/AppointmentUpdateData" } } } ] }, "AppointmentUpdateData": { "type": "object", "description": "Contains the stops whose appointments were updated.", "required": [ "route" ], "x-property-order": [ "route" ], "properties": { "route": { "type": "array", "description": "The stops whose appointment Augment scheduled.", "items": { "$ref": "#/components/schemas/AppointmentUpdateRouteStop" } } } }, "AppointmentUpdateRouteStop": { "type": "object", "required": [ "sequence", "appointmentConfirmation" ], "x-property-order": [ "sequence", "appointmentConfirmation", "externalId" ], "properties": { "sequence": { "type": "integer", "description": "1-based position of the stop on the load's route.", "example": 1 }, "appointmentConfirmation": { "description": "The appointment scheduled for this stop.", "$ref": "#/components/schemas/AppointmentConfirmation" }, "externalId": { "type": "string", "description": "External ID for the stop (if provided). This is used to link the stop to an external system. Omitted when the stop has no external ID.\n", "example": "EXT-STOP-99" } } }, "AppointmentConfirmation": { "type": "object", "description": "The appointment Augment scheduled with the facility.\n", "required": [ "start", "end", "timezone" ], "x-property-order": [ "start", "end", "timezone", "confirmationId" ], "properties": { "start": { "type": "string", "format": "date-time", "description": "Appointment window start time (UTC ISO 8601).", "example": "2026-07-10T13:30:00.000Z" }, "end": { "type": "string", "format": "date-time", "description": "Appointment window end time (UTC ISO 8601).", "example": "2026-07-10T14:00:00.000Z" }, "timezone": { "type": "string", "description": "IANA timezone of the facility (e.g. `America/Chicago`).", "example": "America/Chicago" }, "confirmationId": { "type": "string", "description": "Portal/facility confirmation reference.", "example": "CONF-12345" } } }, "CommunicationDirection": { "type": "string", "enum": [ "INBOUND", "OUTBOUND" ], "description": "Direction of the communication from Augment's point of view. `OUTBOUND` means Augment initiated it; `INBOUND` means Augment received it.\n" }, "AgentContact": { "type": "object", "description": "The person on the other side of an agent communication, or the person a request was routed to.\n\nAny identity field may be `null` when Augment does not hold that detail for the contact. Match on `externalId` where you can; it is your own system's identifier for the contact.\n", "required": [ "name", "externalId", "email", "phone", "phoneExtension" ], "x-property-order": [ "name", "externalId", "email", "phone", "phoneExtension", "role" ], "properties": { "name": { "type": [ "string", "null" ], "description": "Contact's name", "example": "Jane Dispatcher" }, "externalId": { "type": [ "string", "null" ], "description": "Your system's identifier for this contact, as supplied to Augment. `null` when Augment has no matching contact record.\n", "example": "CONTACT-123" }, "email": { "type": [ "string", "null" ], "description": "Contact's email address", "example": "dispatch@carrier.com" }, "phone": { "type": [ "string", "null" ], "description": "Contact's phone number in E.164 format", "example": "+15551234567" }, "phoneExtension": { "type": [ "string", "null" ], "description": "Contact's phone extension", "example": "204" }, "role": { "type": "string", "description": "The contact's role, on call events where Augment has one. Treat as an open set.\n", "examples": [ "DISPATCHER", "DRIVER", "TRACKING", "BOOKING", "AP_REP", "ACCOUNTANT", "AFTER_HOURS_DISPATCHER", "WEEKEND_DISPATCHER", "OTHER" ] } } }, "CallData": { "type": "object", "description": "A completed phone call between an Augment agent and a contact.", "required": [ "callId", "direction", "contact" ], "x-property-order": [ "callId", "direction", "contact", "summary", "callStatus", "callType", "outcome", "actionItems", "analysisStatus", "timestamp", "loadDetails" ], "properties": { "callId": { "type": "string", "description": "Augment's identifier for the call. The same value is sent as `data.callId` on `CALL_RECORDING_AVAILABLE` for that call. Use it to deduplicate completed-call deliveries and to match a completed call to its recording.\n", "example": "01HZXK9P7QM3N8YV4TBWJC2RDF" }, "direction": { "$ref": "#/components/schemas/CommunicationDirection" }, "contact": { "description": "The person on the call.", "$ref": "#/components/schemas/AgentContact" }, "summary": { "type": "string", "description": "Plain-language summary of what was discussed.", "example": "Driver confirmed pickup and is en route to delivery." }, "callStatus": { "type": "string", "description": "How the call attempt ended. Treat as an open set — new values may be added over time.\n", "examples": [ "CONNECTED", "VOICEMAIL", "VOICEMAIL_MESSAGE_LEFT", "NO_ANSWER", "WRONG_NUMBER", "DISCONNECTED", "POOR_CONNECTION", "LANGUAGE_BARRIER", "REQUIRES_DIFFERENT_CONTACT", "COMPLETED", "COMPLETED_WITH_FOLLOWUP", "FAILED", "ATTEMPT_FAILED" ] }, "callType": { "type": "string", "description": "What the call was for. Treat as an open set — new values may be added over time.\n", "examples": [ "CHECK_IN", "INBOUND", "POD_COLLECTION", "LOAD_BUILDING_FACILITY_INFO", "LOAD_BUILDING_CUSTOMER_INFO" ] }, "outcome": { "type": "string", "description": "The agent's categorization of the result. Values vary by `callType`; treat as an open set.\n", "examples": [ "IN_TRANSIT", "DELIVERED", "DELAYED", "ON_TIME", "AT_PICKUP", "PICKED_UP", "AT_DELIVERY", "POD_WILL_SEND_NOW" ] }, "actionItems": { "type": "array", "description": "Follow-up items the agent extracted from the call.", "items": { "type": "string" }, "example": [ "Follow up if driver has not arrived by 16:00." ] }, "analysisStatus": { "type": "string", "description": "State of the call analysis. Treat as an open set — new values may be added over time.\n", "examples": [ "COMPLETED", "FAILED" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When the call happened, in UTC ISO 8601 format, per the voice platform. Distinct from the envelope's `occurredAt`, which is when Augment recorded the event.\n", "example": "2026-05-13T12:34:56Z" }, "loadDetails": { "type": "array", "description": "Per-load information the agent extracted from the call, such as the load's status and the driver's location and ETA. Omitted when the call analysis did not extract any.\n", "items": { "$ref": "#/components/schemas/CallLoadDetail" } } } }, "CallLoadDetail": { "type": "object", "description": "What the call analysis extracted about one load discussed on the call. Every field is optional; a field the analysis did not extract is omitted or `null`.\n", "x-property-order": [ "loadNumber", "loadStatus", "driverLocationCity", "driverLocationState", "driverLocationCountry", "driverLocationLatitude", "driverLocationLongitude", "driverEta" ], "properties": { "loadNumber": { "type": [ "string", "null" ], "description": "The load the details apply to.", "example": "LOAD-456" }, "loadStatus": { "type": [ "string", "null" ], "description": "The load's status as reported on the call. Treat as an open set.\n", "example": "IN_TRANSIT" }, "driverLocationCity": { "type": [ "string", "null" ], "description": "City of the driver's reported location.", "example": "Dallas" }, "driverLocationState": { "type": [ "string", "null" ], "description": "State or province of the driver's reported location.", "example": "TX" }, "driverLocationCountry": { "type": [ "string", "null" ], "description": "Country of the driver's reported location.", "example": "US" }, "driverLocationLatitude": { "type": [ "number", "null" ], "description": "Latitude of the driver's reported location, in decimal degrees.", "example": 32.7767 }, "driverLocationLongitude": { "type": [ "number", "null" ], "description": "Longitude of the driver's reported location, in decimal degrees.", "example": -96.797 }, "driverEta": { "type": [ "string", "null" ], "description": "The driver's estimated arrival time, as given on the call.", "example": "2026-05-13T16:00:00Z" } } }, "CallRecordingData": { "type": "object", "description": "A completed call's recording, with a link to download it.", "required": [ "callId", "direction", "timestamp", "contact" ], "x-property-order": [ "callId", "direction", "callStatus", "timestamp", "contact", "recording" ], "properties": { "callId": { "type": "string", "description": "Augment's identifier for the call.", "example": "01HZXK9P7QM3N8YV4TBWJC2RDF" }, "direction": { "$ref": "#/components/schemas/CommunicationDirection" }, "callStatus": { "type": "string", "description": "How the call ended. Treat as an open set; `UNKNOWN` covers any value Augment does not yet recognize.\n", "examples": [ "CONNECTED", "VOICEMAIL", "VOICEMAIL_MESSAGE_LEFT", "NO_ANSWER", "WRONG_NUMBER", "DISCONNECTED", "POOR_CONNECTION", "LANGUAGE_BARRIER", "REQUIRES_DIFFERENT_CONTACT", "COMPLETED", "COMPLETED_WITH_FOLLOWUP", "FAILED", "ATTEMPT_FAILED", "UNKNOWN" ] }, "timestamp": { "type": "string", "format": "date-time", "description": "When the call occurred, in UTC ISO 8601 format.", "example": "2026-05-13T12:34:56Z" }, "contact": { "description": "The person on the call.", "$ref": "#/components/schemas/CallRecordingContact" }, "recording": { "type": "object", "description": "Populated on every delivery of this event, since a failure to produce a link fails the whole delivery rather than sending this event without it.\n", "required": [ "downloadUrl", "expiresAt" ], "x-property-order": [ "downloadUrl", "expiresAt" ], "properties": { "downloadUrl": { "type": "string", "format": "uri", "description": "Signed link to download the recording, valid for up to 1 hour from when this event is sent. Fetch it before `expiresAt` — once it expires the link stops working and cannot be reissued for this event.\n", "example": "https://d2fx6kyxfjkkep.cloudfront.net/recordings/call_01HZXK9P7QM3N8YV4TBWJC2RDF?Expires=1789500000&Signature=EXAMPLE&Key-Pair-Id=APKAEXAMPLE123" }, "expiresAt": { "type": "string", "format": "date-time", "description": "When `downloadUrl` stops working, in UTC ISO 8601 format.", "example": "2026-05-13T13:34:56Z" } } } } }, "CallRecordingContact": { "type": "object", "description": "The person on the call.", "required": [ "name", "phone" ], "x-property-order": [ "name", "phone", "phoneExtension", "role" ], "properties": { "name": { "type": "string", "description": "Contact's name.", "example": "Jane Dispatcher" }, "phone": { "type": "string", "description": "Contact's phone number in E.164 format.", "example": "+15551234567" }, "phoneExtension": { "type": "string", "description": "Contact's phone extension.", "example": "204" }, "role": { "type": "string", "description": "The contact's role, when Augment has one. Treat as an open set.\n", "examples": [ "DISPATCHER", "DRIVER", "TRACKING", "BOOKING", "AP_REP", "ACCOUNTANT", "AFTER_HOURS_DISPATCHER", "WEEKEND_DISPATCHER", "OTHER" ] } } }, "EmailParticipant": { "type": "object", "description": "A sender or recipient on an email.", "required": [ "name", "address" ], "x-property-order": [ "name", "address" ], "properties": { "name": { "type": "string", "description": "Display name, empty when the email carried only an address.", "example": "Jane Dispatcher" }, "address": { "type": "string", "description": "Email address", "example": "dispatch@carrier.com" } } }, "EmailParticipants": { "type": "object", "description": "Sender and recipients of the email.", "required": [ "from", "to", "cc" ], "x-property-order": [ "from", "to", "cc" ], "properties": { "from": { "$ref": "#/components/schemas/EmailParticipant" }, "to": { "type": "array", "description": "Direct recipients.", "items": { "$ref": "#/components/schemas/EmailParticipant" } }, "cc": { "type": "array", "description": "Copied recipients. Empty array when there were none.", "items": { "$ref": "#/components/schemas/EmailParticipant" } } } }, "EmailData": { "type": "object", "description": "An email an Augment agent sent or received on this load. `summary` and `classification` accompany inbound email.\n", "required": [ "direction", "attachmentCount", "participants" ], "x-property-order": [ "direction", "attachmentCount", "participants", "subject", "summary", "classification" ], "properties": { "direction": { "$ref": "#/components/schemas/CommunicationDirection" }, "attachmentCount": { "type": "integer", "description": "Number of attachments on the email.", "example": 1 }, "participants": { "$ref": "#/components/schemas/EmailParticipants" }, "subject": { "type": "string", "description": "Subject line.", "example": "RE: LOAD-456 delivery update" }, "summary": { "type": "string", "description": "Plain-language summary of the email. Inbound email only.", "example": "Carrier reports delivery completed at 14:05." }, "classification": { "type": "string", "description": "The category Augment assigned to the email. Inbound email only. Treat as an open set — classifications are added over time.\n", "examples": [ "LOAD_TRACKING", "PICKUP_UPDATE", "DELIVERY_UPDATE", "APPOINTMENT_UPDATE", "ISSUE_REPORT", "GENERAL_INQUIRY", "UNKNOWN" ] } } }, "ReceivedTextMessageData": { "type": "object", "description": "An inbound text message received by an Augment agent.", "required": [ "direction", "message" ], "x-property-order": [ "direction", "message", "summary", "classification" ], "properties": { "direction": { "$ref": "#/components/schemas/CommunicationDirection" }, "message": { "type": "string", "description": "The message text.", "example": "Running about an hour behind, hitting traffic on I-80." }, "summary": { "type": "string", "description": "Plain-language summary of the message.", "example": "Driver reports a one-hour delay due to traffic." }, "classification": { "type": "string", "description": "The category Augment assigned to the message. Treat as an open set — the values you receive depend on how your workflows are configured.\n", "examples": [ "LOAD_TRACKING", "DELIVERY_UPDATE" ] } } }, "SentTextMessageData": { "type": "object", "description": "An outbound text message sent by an Augment agent.", "required": [ "direction", "message", "contactType", "contact", "attachmentCount" ], "x-property-order": [ "direction", "message", "contactType", "contact", "attachmentCount" ], "properties": { "direction": { "$ref": "#/components/schemas/CommunicationDirection" }, "message": { "type": "string", "description": "The message text that was sent.", "example": "Hi Jane, checking in on LOAD-456 — any update on ETA?" }, "contactType": { "type": "string", "enum": [ "CarrierContact" ], "description": "The kind of contact the message was addressed to." }, "contact": { "description": "The person the message was sent to.", "$ref": "#/components/schemas/AgentContact" }, "attachmentCount": { "type": "integer", "description": "Number of attachments sent with the message.", "example": 0 } } }, "WorkflowStatusUpdateData": { "type": "object", "description": "A state change on an Augment agent workflow running on this load.", "required": [ "status" ], "x-property-order": [ "status", "agent", "context", "statusReasonCode" ], "properties": { "status": { "type": "string", "enum": [ "NOT_STARTED", "IN_PROGRESS", "COMPLETED", "CANCELED", "ESCALATED", "ERROR" ], "description": "The workflow's new status." }, "agent": { "type": "string", "description": "The agent whose workflow changed status, corresponding to the envelope's `workflow`. Treat as an open set — new agents may be added over time, so tolerate a value you have not seen before.\n", "examples": [ "TRACK_AND_TRACE_AGENT", "CARRIER_SUPPORT_AGENT", "POD_COLLECTION_AGENT", "LOAD_BUILDING_AGENT", "CARRIER_SELECTION_AGENT", "LOAD_SCHEDULING_AGENT", "CUSTOMER_SUPPORT_AGENT" ] }, "context": { "type": "string", "description": "Free-text explanation of the status change.", "example": "Carrier unreachable after three attempts." }, "statusReasonCode": { "type": "string", "description": "Workflow-specific reason for the status change. Free-form and not a fixed vocabulary — treat as an open set and do not branch on values you have not agreed with Augment.\n", "example": "MISSING_CONTACT_INFO" } } }, "HumanAssistanceRequestedData": { "type": "object", "description": "An agent's request to hand a load off to a human.", "required": [ "reasonCode", "contact" ], "x-property-order": [ "reasonCode", "contact" ], "properties": { "reasonCode": { "type": "string", "enum": [ "DIRECT_REQUEST", "LOAD_LOOKUP_FAILURE", "CARRIER_LOOKUP_FAILURE", "INSUFFICIENT_INFORMATION" ], "description": "Why the agent asked for help. `DIRECT_REQUEST` means someone on the call or thread asked for a human; the others mean the agent could not proceed on its own.\n" }, "contact": { "description": "The person at your brokerage the request was routed to.", "$ref": "#/components/schemas/AgentContact" } } }, "CompletedCallEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "COMPLETED_CALL" ], "description": "Event name for a completed outbound call." }, "data": { "description": "Call data payload.", "$ref": "#/components/schemas/CallData" } } } ] }, "CompletedInboundCallEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "COMPLETED_INBOUND_CALL" ], "description": "Event name for a completed inbound call." }, "data": { "description": "Call data payload.", "$ref": "#/components/schemas/CallData" } } } ] }, "CallRecordingAvailableEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "CALL_RECORDING_AVAILABLE" ], "description": "Event name for a call recording becoming available for download." }, "data": { "description": "Call recording data payload.", "$ref": "#/components/schemas/CallRecordingData" } } } ] }, "NewEmailEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "NEW_EMAIL" ], "description": "Event name for a received email." }, "data": { "description": "Email data payload.", "$ref": "#/components/schemas/EmailData" } } } ] }, "NewRepEmailEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "NEW_REP_EMAIL" ], "description": "Event name for a received email from one of your reps." }, "data": { "description": "Email data payload.", "$ref": "#/components/schemas/EmailData" } } } ] }, "SentEmailEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "SENT_EMAIL" ], "description": "Event name for an email sent by an Augment agent." }, "data": { "description": "Email data payload.", "$ref": "#/components/schemas/EmailData" } } } ] }, "ReceivedExternalTextMessageEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "RECEIVED_EXTERNAL_TEXT_MESSAGE" ], "description": "Event name for a received text message." }, "data": { "description": "Received text message data payload.", "$ref": "#/components/schemas/ReceivedTextMessageData" } } } ] }, "SentExternalTextMessageEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "SENT_EXTERNAL_TEXT_MESSAGE" ], "description": "Event name for a text message sent by an Augment agent." }, "data": { "description": "Sent text message data payload.", "$ref": "#/components/schemas/SentTextMessageData" } } } ] }, "WorkflowStatusUpdateEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "WORKFLOW_STATUS_UPDATE" ], "description": "Event name for a workflow status change." }, "data": { "description": "Workflow status data payload.", "$ref": "#/components/schemas/WorkflowStatusUpdateData" } } } ] }, "HumanAssistanceRequestedEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "HUMAN_ASSISTANCE_REQUESTED" ], "description": "Event name for a human-assistance request." }, "data": { "description": "Human assistance request data payload.", "$ref": "#/components/schemas/HumanAssistanceRequestedData" } } } ] }, "CanceledScheduledOutreachEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "CANCELED_SCHEDULED_OUTREACH" ], "description": "Event name for a canceled scheduled carrier outreach." }, "data": { "description": "The outreach that was canceled. Same shape as `SCHEDULED_CARRIER_OUTREACH`.\n", "$ref": "#/components/schemas/ScheduledCarrierOutreachData" } } } ] }, "CarrierIssueUpdatedEvent": { "allOf": [ { "$ref": "#/components/schemas/EventEnvelope" }, { "type": "object", "required": [ "eventType", "data" ], "x-property-order": [ "eventType", "data" ], "properties": { "eventType": { "type": "string", "enum": [ "CARRIER_ISSUE_UPDATED" ], "description": "Event name for carrier issue updates." }, "data": { "description": "Carrier issue data payload.", "$ref": "#/components/schemas/CarrierIssueUpdatedData" } } } ] }, "CarrierIssueUpdatedData": { "type": "object", "description": "A standardized carrier issue notification. Sent when the carrier-support agent creates or updates an issue (detention, lumper, TONU, breakdown, damage, shortage, overage, or other incident) on a load.\n", "required": [ "carrierIssueId", "issueType", "status", "description" ], "x-property-order": [ "carrierIssueId", "issueType", "status", "stopType", "stopSequenceNumber", "amountCents", "waitTimeMinutes", "description", "resolution", "externalId" ], "properties": { "carrierIssueId": { "type": [ "string", "null" ], "description": "Correlation token for this carrier issue (Augment's internal incident record id). Echo it back on the callback to update the same incident in place. Null if not yet available.\n", "example": "01JCARRIERISSUERECORD00001" }, "issueType": { "type": "string", "enum": [ "DETENTION_PICKUP", "DETENTION_DELIVERY", "LUMPER", "TONU", "LAYOVER", "BREAKDOWN", "DAMAGE", "SHORTAGE", "OVERAGE", "OTHER" ], "description": "The category of carrier issue." }, "status": { "type": "string", "enum": [ "OPEN", "RESOLVED", "CANCELED" ], "description": "Current lifecycle status of the issue." }, "stopType": { "type": [ "string", "null" ], "enum": [ "PICKUP", "DELIVERY", null ], "description": "Which stop type is affected, if applicable." }, "stopSequenceNumber": { "type": [ "integer", "null" ], "description": "1-indexed position of the affected stop on the route.", "example": 1 }, "amountCents": { "type": [ "integer", "null" ], "description": "Monetary claim amount in USD cents (e.g. lumper fee, detention charge).", "example": 15000 }, "waitTimeMinutes": { "type": [ "integer", "null" ], "description": "Wait or detention duration in minutes.", "example": 180 }, "description": { "type": "string", "description": "Full narrative description of the issue.", "example": "Carrier reported 3-hour wait at shipper. Appointment was 08:00, arrived 07:45, still not loaded as of 11:00." }, "resolution": { "type": [ "string", "null" ], "description": "How the issue was resolved. Populated when status is RESOLVED.", "example": null }, "externalId": { "type": "string", "description": "The incident id in your TMS, once you have reported it back via the callback. When present, treat this event as an update to that existing incident rather than a new one.\n", "example": "TMS-INC-30275" } } }, "PurchaseOrderUpdate": { "type": "object", "description": "New expected dates for a purchase order and its lines, as stated by the supplier. Scoped to the purchase order, with the affected lines nested. Apply the dates as updated promise dates on the purchase order.\n\nThe whole request body, sent without the shared event envelope.\n\nEvery event carries at least one new date — on the purchase order, on a line, or both. Each date field is individually optional because dates appear only at the level the supplier stated them, so no single field is the one that is always set. That is a guarantee about what Augment sends, not a shape you have to validate.\n", "required": [ "purchaseOrderNumber", "lineItems", "source", "collectedAt" ], "x-property-order": [ "purchaseOrderNumber", "expectedShipDate", "expectedArrivalDate", "note", "lineItems", "source", "collectedAt" ], "properties": { "purchaseOrderNumber": { "type": "string", "description": "Your purchase order number, as sent when the purchase order was created.\n", "example": "PO-1001" }, "expectedShipDate": { "type": [ "string", "null" ], "format": "date", "description": "New expected ship date for the whole purchase order, as a UTC calendar day. Present only when the supplier stated one date for the order rather than per line. Null otherwise.\n", "example": null }, "expectedArrivalDate": { "type": [ "string", "null" ], "format": "date", "description": "New expected arrival date for the whole purchase order, as a UTC calendar day. Present only when the supplier stated one date for the order rather than per line. Null otherwise.\n", "example": null }, "note": { "type": [ "string", "null" ], "description": "What the typed fields cannot carry — the supplier's account of why the dates moved, at purchase order level.\n", "example": "2 units of RH110 backordered until late September." }, "lineItems": { "type": "array", "description": "The lines that have a new date. Lines the supplier said nothing new about are omitted, so this array is empty when the supplier stated dates only at purchase order level.\n", "items": { "$ref": "#/components/schemas/PurchaseOrderUpdateLineItem" } }, "source": { "type": "string", "enum": [ "SUPPLIER_EMAIL" ], "description": "Where the dates came from. New values may be added as Augment collects updates over other channels, so treat this as an open set.\n", "example": "SUPPLIER_EMAIL" }, "collectedAt": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "When Augment collected the update from the supplier, as a UTC ISO 8601 timestamp ending in `Z`. Use it to order updates for the same purchase order — a later `collectedAt` reflects the more recent thing the supplier said.\n" } ] } } }, "PurchaseOrderUpdateLineItem": { "type": "object", "description": "One purchase order line that has a new expected date.", "required": [ "identifier" ], "x-property-order": [ "identifier", "expectedShipDate", "expectedArrivalDate", "note" ], "properties": { "identifier": { "type": "string", "description": "How the supplier referred to the line. Matches the `lineNumber` you sent on the purchase order when Augment can resolve it; otherwise it is the identifier the supplier used, which is often a SKU and sometimes prose such as `Line 2`. Resolve it against your own lines before applying the dates, and route what you cannot match for review — this field is not a guaranteed reference to a line you sent.\n", "example": "RH110" }, "expectedShipDate": { "type": [ "string", "null" ], "format": "date", "description": "New expected ship date for this line, as a UTC calendar day. Null when the supplier gave no new ship date for the line.\n", "example": "2026-09-25" }, "expectedArrivalDate": { "type": [ "string", "null" ], "format": "date", "description": "New expected arrival date for this line, as a UTC calendar day. Null when the supplier gave no new arrival date for the line.\n", "example": null }, "note": { "type": [ "string", "null" ], "description": "What the typed fields cannot carry — the supplier's account of why this line's dates moved.\n", "example": "Due into supplier late September." } } }, "TrackingEvent": { "type": "object", "description": "A location or tracking update derived from carrier communication.", "required": [ "eventType", "eventSource", "eventUtc" ], "x-property-order": [ "eventType", "eventCode", "eventSource", "eventUtc", "eventLocalTime", "nextSequence", "nextEtaUtc", "city", "country", "stateOrProvince", "postalCode", "latitude", "longitude", "temperatureF", "notes", "dispatcher", "driver" ], "properties": { "eventType": { "type": "string", "enum": [ "DELAYED", "INFO", "PICKED_UP", "PING", "DRIVER_AT_PICKUP", "DRIVER_AT_DELIVERY", "DELIVERED", "COVERED", "DISPATCHED" ], "description": "Type of tracking event" }, "eventCode": { "type": "string", "enum": [ "AA", "AB", "AF", "AG", "AM", "AR", "B1", "CD", "D1", "J1", "NS", "OA", "X1", "X3", "X4", "X6" ], "description": "Optional EDI 214 tracking status code." }, "eventSource": { "type": "string", "enum": [ "4KITES", "CARRIER_API", "HIGHWAY", "MACROPOINT", "P44", "SMC3", "TRUCKER_TOOLS", "PHONE_EMAIL", "PHONE", "EMAIL", "TEXT", "TMS", "OTHER" ], "description": "How the tracking data was obtained" }, "eventUtc": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Event time as a UTC ISO 8601 timestamp ending in `Z`." } ] }, "eventLocalTime": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Event time as a UTC ISO 8601 timestamp ending in `Z`." } ] }, "nextSequence": { "type": "integer", "description": "Next stop sequence number", "example": 1 }, "nextEtaUtc": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Next estimated arrival time as a UTC ISO 8601 timestamp ending in `Z`." } ] }, "city": { "type": "string" }, "country": { "type": "string" }, "stateOrProvince": { "type": "string" }, "postalCode": { "type": "string" }, "latitude": { "type": "number", "example": 0 }, "longitude": { "type": "number", "example": 0 }, "temperatureF": { "type": "number", "description": "Temperature in Fahrenheit (if available)" }, "notes": { "type": "string", "description": "Free-text context from the carrier communication" }, "dispatcher": { "$ref": "#/components/schemas/TrackingEventContact" }, "driver": { "$ref": "#/components/schemas/TrackingEventContact" } } }, "StopUpdate": { "type": "object", "description": "A stop status change at a pickup or delivery.", "required": [ "stopSequenceNumber", "status", "timezone" ], "x-property-order": [ "stopSequenceNumber", "stopId", "status", "arrivalTime", "unloadStartTime", "unloadEta", "departureTime", "timezone", "accessorials", "dockDoor", "notes", "address" ], "properties": { "stopSequenceNumber": { "type": "integer", "description": "1-based stop sequence number", "example": 1 }, "stopId": { "type": "string", "description": "External stop identifier" }, "status": { "$ref": "#/components/schemas/StopUpdateLoadStatus", "example": "AT_PICKUP" }, "arrivalTime": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Arrival time at the stop as a UTC ISO 8601 timestamp ending in `Z`.\n" } ] }, "departureTime": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Departure time from the stop as a UTC ISO 8601 timestamp ending in `Z`.\n" } ] }, "unloadStartTime": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Unload start time as a UTC ISO 8601 timestamp ending in `Z`.\n" } ] }, "unloadEta": { "allOf": [ { "$ref": "#/components/schemas/InputDateTimeUtc" }, { "description": "Estimated unload completion time as a UTC ISO 8601 timestamp ending in `Z`.\n" } ] }, "timezone": { "type": "string", "description": "IANA timezone (e.g., America/Chicago) of the stop location.", "examples": [ "America/Chicago", "America/Los_Angeles" ] }, "accessorials": { "type": "array", "items": { "$ref": "#/components/schemas/AccessorialsEnum" } }, "dockDoor": { "type": "string", "description": "Dock door assignment" }, "notes": { "type": "string", "description": "Free-text context" }, "address": { "$ref": "#/components/schemas/StopAddress" } } }, "StopAddress": { "type": "object", "description": "Address of this stop, from the load's route. Omitted when no matching route stop is found. When present, every required field below is populated.\n", "required": [ "street1", "city", "stateOrProvince", "postalCode", "country" ], "x-property-order": [ "company", "street1", "street2", "city", "stateOrProvince", "postalCode", "country" ], "properties": { "company": { "type": "string", "description": "Company or facility name at this address" }, "street1": { "type": "string", "description": "Primary street address" }, "street2": { "type": "string", "description": "Secondary address line (suite, unit, etc.)" }, "city": { "type": "string" }, "stateOrProvince": { "type": "string" }, "postalCode": { "type": "string" }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "example": "US" } } }, "CarrierUpdate": { "type": "object", "description": "Updated driver, truck, or trailer information from carrier communication.", "required": [ "source" ], "x-property-order": [ "source", "driverName", "driverPhoneNumber", "truckNumber", "trailerNumber", "bolNumber", "notes" ], "properties": { "source": { "type": "string", "enum": [ "EMAIL", "PHONE" ], "description": "How the carrier information was obtained" }, "driverName": { "type": "string", "description": "Driver's full name" }, "driverPhoneNumber": { "type": "string", "description": "Driver's phone number" }, "truckNumber": { "type": "string", "description": "Truck or power unit number" }, "trailerNumber": { "type": "string", "description": "Trailer number" }, "bolNumber": { "type": "string", "description": "Bill of Lading number" }, "notes": { "type": "string", "description": "Free-text context" } } }, "CommunicationData": { "type": "object", "description": "Free-text communication update. Used by COMMENT events.\n", "required": [ "comment" ], "x-property-order": [ "comment" ], "properties": { "comment": { "type": "string", "description": "Communication text that does not map to a structured event type." } } }, "TrackingEventContact": { "type": "object", "description": "Contact information for a person associated with a tracking event.", "x-property-order": [ "id", "name", "phone", "phoneExtension", "email" ], "properties": { "id": { "type": "string", "description": "Identifier of the contact in the TMS system." }, "name": { "type": "string", "description": "Full name of the contact." }, "phone": { "type": "string", "description": "Phone number in E.164 format (e.g., +12081234567) or common local format. Supports US, CA, MX, PH.", "example": "+12081234567" }, "phoneExtension": { "type": "string", "description": "Phone number extension (numeric only)." }, "email": { "type": "string", "description": "Email address of the contact." } } }, "StopUpdateLoadStatus": { "type": "string", "enum": [ "AT_PICKUP", "AT_DELIVERY", "IN_TRANSIT", "DELIVERED" ], "description": "Status code indicating the current state of the load at the stop" }, "AccessorialsEnum": { "type": "string", "description": "Accessorial code representing an additional service or requirement for a load. This is not a closed set - new accessorial codes may be added at any time. Values are normalized to UPPER_SNAKE_CASE (e.g., `inside delivery` -> `INSIDE_DELIVERY`).\n", "examples": [ "AFTER_HOURS", "BULK_HEAD", "CHAINS", "CONSTRUCTION_SITE", "DELIVERY_APPOINTMENT", "DETENTION", "DETENTION_LOADING", "DETENTION_UNLOADING", "DRIVER_ASSIST", "DRIVER_COUNT", "E_TRACKING", "FOOD_GRADE", "FORKLIFT", "GENERAL_LIABILITY", "GUARANTEED_APPOINTMENT_DELIVERY", "HAZMAT", "HIGH_VALUE", "HIGH_VISIBILITY", "HOLIDAY", "INSIDE_DELIVERY", "INSIDE_PICKUP", "LAYOVER", "LIFTGATE", "LIMITED_ACCESS", "LOAD_BAR", "LUMPER", "MILITARY_BASE", "NOTIFY_BEFORE_ARRIVAL", "OVERSIZE", "OVERWEIGHT", "OVER_LENGTH_SHIPMENT", "PICKUP_APPOINTMENT", "POD_REQUIRED", "PROTECT_FROM_FREEZE", "RAMPS", "RESIDENTIAL", "SIGNATURE_REQUIRED", "SORT_AND_SEGREGATE", "STOP_OFF_CHARGE", "STRAPS", "TANKER_ENDORSED", "TARGETED_COMMODITY", "TARPS", "TEAM_SERVICE", "TEMPERATURE_REQUIREMENT", "TRADESHOW", "TRAILER_CLEANING", "TONU", "TRAILER_INTERCHANGE", "TWIC", "WEEKEND" ] }, "InputDateTimeUtc": { "type": "string", "format": "date-time", "description": "UTC ISO 8601 timestamp ending in `Z`. Timezone offsets are not supported.", "examples": [ "2025-08-21T12:34:56Z" ] } } }, "x-ext-urls": {} }