Sign in
Use case / Fleet dispatch
Webhooks / Inbound
Use case / Document import

External Document Upload From A Fleet Application

Upload a document to a specific stop or stop group on a fleet-dispatched trip.

This webhook uses Basic Auth (webhook credentials), not the OAuth credentials used for the API. Contact integrations@qargo.com to request credentials.

Query parameters

ParameterRequiredDescription
question_path_keyYesMaps the file to a document type in Qargo (e.g. CMR, POD, WEIGHT_NOTE)
stop_idNo*The Qargo UUID of the stop to attach the document to
stop_group_idNo*The Qargo UUID of the stop group to attach the document to

*Provide either stop_id or stop_group_id to identify where to attach the document.

Headers

HeaderRequiredDescription
Content-TypeYesMIME type of the file (e.g. application/pdf, image/jpeg)
Content-DispositionNoProvides the filename: attachment; filename="POD.pdf"

Filename handling

The uploaded file's name in Qargo is determined by:

  1. If Content-Disposition includes a filename — that value is used, combined with the question path key default. For example: filename="pod1234.pdf" with question path key default POD.pdf → stored as pod1234_POD.pdf.
  2. If no Content-Disposition is provided — the default filename from the question path key configuration is used.

Example

curl -X POST \
  "https://api.qargo.com/v1/webhook/fleet-document-upload\
  ?question_path_key=POD&stop_id=<stop_uuid>" \
  -u "<webhook_client_id>:<webhook_secret_id>" \
  -H "Content-Type: application/pdf" \
  -H "Content-Disposition: attachment; filename=POD.pdf" \
  --data-binary @/path/to/document.pdf
post/v1/webhook/fleet-document-upload

Query parameters

question_path_keystring required

The question path key to map the file in Qargo, for example: CMR/POD

stop_idstring nullable

The stop ID to which the document is related

stop_group_idstring nullable

The stop group ID to which the document is related

Request body

string binary required
OR
object required
OR
OR
string required
OR
integer required
OR
number required
OR
boolean required

Response

Successful Response

{"stackTrail":"paths:/v1/webhook/fleet-document-upload:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

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