Load Building

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.

post/UPLOAD_DOCUMENT

Request

Base URL
https://apidocs.goaugment.com (the document declares no server; this is the origin it was published from)
Auth
none required
TypeScript
https://skmtc.dev/goaugment/apis/webhooks/docs/UPLOAD_DOCUMENT/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

idstring required

Unique event identifier (ULID)

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.

occurredAtstring date-time required

When the underlying activity occurred (ISO 8601)

loadNumberstring nullable required

Your load reference number

customerLoadInternalIdstring nullable required

Your internal load ID, if provided during load creation

eventType'UPLOAD_DOCUMENT' required

Event name for a document upload.

Example request

{
  "data": {
    "filename": "invoice-1234.pdf",
    "contentType": "application/pdf"
  }
}

Response

Upload results, including per-file success or failure details

Changes

No recorded changes to this operation across all 1 revision of this API.