Event types
Every request body has the same envelope: type, timestamp and data. The tables below list the fields of data for each event.
They are generated from the OpenAPI description of the webhooks.
Notes:
- Archiving an order is sent as
companyorder.updated.companyorder.deletedis only sent when an order is deleted. customer.deletedis sent when a customer is deleted. It can no longer be fetched afterwards.partner.deletedis sent when a partner (subcontractor) is deleted. It can no longer be fetched afterwards.companyorder.document_uploadedis sent when a driver (DriverApp), a shipper (ShipperPortal) or a partner (shared order link) uploads documents to an order.data.object.documentsonly contains the newly uploaded documents. Documents uploaded by your own dispatchers in CargoApps are sent ascompanyorder.updated.- New fields can be added to the payloads at any time. Ignore fields you don't know.
companyorder.created
An order was created.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of an order. Fetch the full order with companyOrders(query: { _id }). |
data.object.id | string | yes | Order ID. |
data.object.reference | string | yes | Order reference. |
data.object.status | enum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLED | yes | Current order status. |
data.object.archived | boolean | yes | Whether the order is archived. Archiving is sent as companyorder.updated. |
data.object.deleted | boolean | yes | Whether the order is deleted. Always true for companyorder.deleted. |
data.object.updatedAt | string (date-time) | yes | Last update of the order. |
Example body
{
"type": "companyorder.created",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"reference": "ORD-2026-0042",
"status": "OPEN",
"archived": false,
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
companyorder.updated
An order was updated (including archiving).
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of an order. Fetch the full order with companyOrders(query: { _id }). |
data.object.id | string | yes | Order ID. |
data.object.reference | string | yes | Order reference. |
data.object.status | enum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLED | yes | Current order status. |
data.object.archived | boolean | yes | Whether the order is archived. Archiving is sent as companyorder.updated. |
data.object.deleted | boolean | yes | Whether the order is deleted. Always true for companyorder.deleted. |
data.object.updatedAt | string (date-time) | yes | Last update of the order. |
Example body
{
"type": "companyorder.updated",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"reference": "ORD-2026-0042",
"status": "OPEN",
"archived": false,
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
companyorder.status_changed
The status of an order changed.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of an order. Fetch the full order with companyOrders(query: { _id }). |
data.object.id | string | yes | Order ID. |
data.object.reference | string | yes | Order reference. |
data.object.status | enum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLED | yes | Current order status. |
data.object.archived | boolean | yes | Whether the order is archived. Archiving is sent as companyorder.updated. |
data.object.deleted | boolean | yes | Whether the order is deleted. Always true for companyorder.deleted. |
data.object.updatedAt | string (date-time) | yes | Last update of the order. |
Example body
{
"type": "companyorder.status_changed",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"reference": "ORD-2026-0042",
"status": "OPEN",
"archived": false,
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
companyorder.deleted
An order was deleted.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of an order. Fetch the full order with companyOrders(query: { _id }). |
data.object.id | string | yes | Order ID. |
data.object.reference | string | yes | Order reference. |
data.object.status | enum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLED | yes | Current order status. |
data.object.archived | boolean | yes | Whether the order is archived. Archiving is sent as companyorder.updated. |
data.object.deleted | boolean | yes | Whether the order is deleted. Always true for companyorder.deleted. |
data.object.updatedAt | string (date-time) | yes | Last update of the order. |
Example body
{
"type": "companyorder.deleted",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"reference": "ORD-2026-0042",
"status": "OPEN",
"archived": false,
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
companyorder.document_uploaded
Documents were uploaded to an order by a driver (DriverApp), a shipper (ShipperPortal) or a partner (shared order link). Documents uploaded by your own dispatchers via the CargoApps trigger companyorder.updated instead.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of an order with the documents that were just uploaded. Fetch all documents of the order with companyOrders(query: { _id }). |
data.object.id | string | yes | Order ID. |
data.object.reference | string | yes | Order reference. |
data.object.status | enum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLED | yes | Current order status. |
data.object.archived | boolean | yes | Whether the order is archived. Archiving is sent as companyorder.updated. |
data.object.deleted | boolean | yes | Whether the order is deleted. Always true for companyorder.deleted. |
data.object.updatedAt | string (date-time) | yes | Last update of the order. |
data.object.documents | array of objects | yes | Only the documents uploaded with this event, not all documents of the order. |
data.object.documents[].id | string | yes | Document ID. |
data.object.documents[].name | string | yes | File name. |
data.object.documents[].type | enum: POD_UPLOAD, ATTACHMENT_UPLOAD, WEIGHING_DOCUMENT | yes | Kind of document: proof of delivery, weighing document or other attachment. |
data.object.documents[].url | string | yes | Download URL of the file. |
data.object.documents[].contentType | string | no | MIME type of the file, if known. |
data.object.documents[].size | number | yes | File size in bytes. |
data.object.documents[].stopId | string | no | Stop the document was uploaded at, if any. |
data.object.documents[].createdAt | string (date-time) | yes | When the document was uploaded. |
Example body
{
"type": "companyorder.document_uploaded",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"reference": "ORD-2026-0042",
"status": "OPEN",
"archived": false,
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z",
"documents": [
{
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "pod.pdf",
"type": "POD_UPLOAD",
"url": "https://example.com/documents/pod.pdf",
"contentType": "application/pdf",
"size": 12345,
"stopId": "64b7f0c2a1b2c3d4e5f60718",
"createdAt": "2026-10-12T08:15:30.000Z"
}
]
}
}
}
customer.created
A customer was created.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a customer. Fetch the full customer with costprofilesCustomer(ids). |
data.object.id | string | yes | Customer ID. |
data.object.name | string | yes | Customer (company) name. |
data.object.deleted | boolean | yes | Whether the customer is deleted. Always true for customer.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the customer. |
Example body
{
"type": "customer.created",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
customer.updated
A customer was updated.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a customer. Fetch the full customer with costprofilesCustomer(ids). |
data.object.id | string | yes | Customer ID. |
data.object.name | string | yes | Customer (company) name. |
data.object.deleted | boolean | yes | Whether the customer is deleted. Always true for customer.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the customer. |
Example body
{
"type": "customer.updated",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
customer.deleted
A customer was deleted.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a customer. Fetch the full customer with costprofilesCustomer(ids). |
data.object.id | string | yes | Customer ID. |
data.object.name | string | yes | Customer (company) name. |
data.object.deleted | boolean | yes | Whether the customer is deleted. Always true for customer.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the customer. |
Example body
{
"type": "customer.deleted",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
partner.created
A partner was created.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids). |
data.object.id | string | yes | Partner ID. |
data.object.name | string | yes | Partner (company) name. |
data.object.deleted | boolean | yes | Whether the partner is deleted. Always true for partner.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the partner. |
Example body
{
"type": "partner.created",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
partner.updated
A partner was updated.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids). |
data.object.id | string | yes | Partner ID. |
data.object.name | string | yes | Partner (company) name. |
data.object.deleted | boolean | yes | Whether the partner is deleted. Always true for partner.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the partner. |
Example body
{
"type": "partner.updated",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}
partner.deleted
A partner was deleted.
| Field | Type | Required | Description |
|---|---|---|---|
data.companyId | string | yes | Company the event belongs to. |
data.object | object | yes | Lean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids). |
data.object.id | string | yes | Partner ID. |
data.object.name | string | yes | Partner (company) name. |
data.object.deleted | boolean | yes | Whether the partner is deleted. Always true for partner.deleted. |
data.object.updatedAt | string (date-time) | no | Last update of the partner. |
Example body
{
"type": "partner.deleted",
"timestamp": "2026-10-12T08:15:30.000Z",
"data": {
"companyId": "64b7f0c2a1b2c3d4e5f60718",
"object": {
"id": "64b7f0c2a1b2c3d4e5f60718",
"name": "ACME Logistics GmbH",
"deleted": false,
"updatedAt": "2026-10-12T08:15:30.000Z"
}
}
}