Optional

Upload Document

​

v1 equivalent: uploadDocument (flat payload — the data fields below are sent at the top level, without the envelope).

Sent 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.

Two delivery encodings, selected by your endpoint's configuration:

  • application/json (default): the file bytes are base64-encoded in data.content, wrapped in the standard envelope.

  • 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.

Body·
required

Fields present on every v2 webhook event.

    • customerLoadInternalId
      Type: string | null
      required

      Your internal load ID, if provided during load creation

    • data
      Type: object ·
      required

      Document upload data payload. In multipart/form-data deliveries, content is omitted here and sent as the content file part instead.

    • eventType
      enum
      const:  
      UPLOAD_DOCUMENT
      required

      Event name for a document upload.

      values
      • UPLOAD_DOCUMENT
    • id
      Type: string
      required

      Unique event identifier (ULID)

    • loadNumber
      Type: string | null
      required

      Your load reference number

    • occurredAt
      Type: string Format: date-time
      required

      When the underlying activity occurred (ISO 8601)

    • workflow
      Type: string | null enum
      required

      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.

      values
      • TRACK_AND_TRACE
      • CARRIER_SUPPORT
      • POD_COLLECTION
      • LOAD_BUILDING
      • CARRIER_SELECTION
      • SCHEDULING
      • CUSTOMER_SUPPORT
      • null
Responses
  • application/json
  • application/json
Request Example for post/UPLOAD_DOCUMENT
curl /UPLOAD_DOCUMENT \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "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"
  }
}'

{
  "summary": {
    "total": 1,
    "succeeded": 1,
    "failed": 1
  },
  "results": [
    {
      "filename": "string",
      "success": true,
      "data": {
        "size": 1,
        "contentType": "string",
        "id": "string"
      }
    }
  ]
}

Upload results, including per-file success or failure details