Operational Visibility Event

Request

Webhook for updates to orders. Subscribe to this endpoint to receive updates. Trip updates are not sent by default and require a custom setup configured by Qargo. Contact success@qargo.com to discuss setting this up.

By default, Qargo sends payloads using the OperationalVisibilityUpdate schema:

order for OrderUpdate, StopUpdate, DocumentUpdate, EtaUpdate, and HandlingUnitUpdate events.

OrderImportUpdate and other events not listed above may not include order. The trip field is not populated by default; including it requires a custom webhook format configured by Qargo.

A custom webhook format configured by Qargo may use a different structure.

Bodyapplication/jsonrequired

Any of:

eventsArray of objects(Events)required

Events tracked in this update. PositionUpdate is not implemented yet. 🚧

orderVisibilityOrder (object) or null

Any of:

Current state of the order. Included for OrderUpdate, StopUpdate, DocumentUpdate, EtaUpdate, and HandlingUnitUpdate events. Never included together with trip on the same event.

tripVisibilityTrip (object) or null

Any of:

Current state of the trip. This field is not populated by default. Including it requires a custom webhook format configured by Qargo.

{
  "events": [
    { … }
  ],
  "order": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "order_name": "INV-7980",
    "customer_reference_number": "string",
    "customer": { … },
    "status": "ACCEPTED",
    "custom_fields": {},
    "stops": [ … ],
    "consignment": { … }
  },
  "trip": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string",
    "orders": [ … ],
    "stops": [ … ]
  }
}

Responses

Successful Response

Bodyapplication/json

any

Response

// No response example