Skip to main content

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.deleted is only sent when an order is deleted.
  • customer.deleted is sent when a customer is deleted. It can no longer be fetched afterwards.
  • partner.deleted is sent when a partner (subcontractor) is deleted. It can no longer be fetched afterwards.
  • companyorder.document_uploaded is sent when a driver (DriverApp), a shipper (ShipperPortal) or a partner (shared order link) uploads documents to an order. data.object.documents only contains the newly uploaded documents. Documents uploaded by your own dispatchers in CargoApps are sent as companyorder.updated.
  • New fields can be added to the payloads at any time. Ignore fields you don't know.

companyorder.created

An order was created.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of an order. Fetch the full order with companyOrders(query: { _id }).
data.object.idstringyesOrder ID.
data.object.referencestringyesOrder reference.
data.object.statusenum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLEDyesCurrent order status.
data.object.archivedbooleanyesWhether the order is archived. Archiving is sent as companyorder.updated.
data.object.deletedbooleanyesWhether the order is deleted. Always true for companyorder.deleted.
data.object.updatedAtstring (date-time)yesLast 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).

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of an order. Fetch the full order with companyOrders(query: { _id }).
data.object.idstringyesOrder ID.
data.object.referencestringyesOrder reference.
data.object.statusenum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLEDyesCurrent order status.
data.object.archivedbooleanyesWhether the order is archived. Archiving is sent as companyorder.updated.
data.object.deletedbooleanyesWhether the order is deleted. Always true for companyorder.deleted.
data.object.updatedAtstring (date-time)yesLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of an order. Fetch the full order with companyOrders(query: { _id }).
data.object.idstringyesOrder ID.
data.object.referencestringyesOrder reference.
data.object.statusenum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLEDyesCurrent order status.
data.object.archivedbooleanyesWhether the order is archived. Archiving is sent as companyorder.updated.
data.object.deletedbooleanyesWhether the order is deleted. Always true for companyorder.deleted.
data.object.updatedAtstring (date-time)yesLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of an order. Fetch the full order with companyOrders(query: { _id }).
data.object.idstringyesOrder ID.
data.object.referencestringyesOrder reference.
data.object.statusenum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLEDyesCurrent order status.
data.object.archivedbooleanyesWhether the order is archived. Archiving is sent as companyorder.updated.
data.object.deletedbooleanyesWhether the order is deleted. Always true for companyorder.deleted.
data.object.updatedAtstring (date-time)yesLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of an order with the documents that were just uploaded. Fetch all documents of the order with companyOrders(query: { _id }).
data.object.idstringyesOrder ID.
data.object.referencestringyesOrder reference.
data.object.statusenum: OPEN, AUCTION, PLANNING, PLANNED, DECLINED, ASSIGNED, CONFIRMED, IN_PROGRESS, FINISHED, BILL_CREATED, PAID, CANCELLEDyesCurrent order status.
data.object.archivedbooleanyesWhether the order is archived. Archiving is sent as companyorder.updated.
data.object.deletedbooleanyesWhether the order is deleted. Always true for companyorder.deleted.
data.object.updatedAtstring (date-time)yesLast update of the order.
data.object.documentsarray of objectsyesOnly the documents uploaded with this event, not all documents of the order.
data.object.documents[].idstringyesDocument ID.
data.object.documents[].namestringyesFile name.
data.object.documents[].typeenum: POD_UPLOAD, ATTACHMENT_UPLOAD, WEIGHING_DOCUMENTyesKind of document: proof of delivery, weighing document or other attachment.
data.object.documents[].urlstringyesDownload URL of the file.
data.object.documents[].contentTypestringnoMIME type of the file, if known.
data.object.documents[].sizenumberyesFile size in bytes.
data.object.documents[].stopIdstringnoStop the document was uploaded at, if any.
data.object.documents[].createdAtstring (date-time)yesWhen 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a customer. Fetch the full customer with costprofilesCustomer(ids).
data.object.idstringyesCustomer ID.
data.object.namestringyesCustomer (company) name.
data.object.deletedbooleanyesWhether the customer is deleted. Always true for customer.deleted.
data.object.updatedAtstring (date-time)noLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a customer. Fetch the full customer with costprofilesCustomer(ids).
data.object.idstringyesCustomer ID.
data.object.namestringyesCustomer (company) name.
data.object.deletedbooleanyesWhether the customer is deleted. Always true for customer.deleted.
data.object.updatedAtstring (date-time)noLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a customer. Fetch the full customer with costprofilesCustomer(ids).
data.object.idstringyesCustomer ID.
data.object.namestringyesCustomer (company) name.
data.object.deletedbooleanyesWhether the customer is deleted. Always true for customer.deleted.
data.object.updatedAtstring (date-time)noLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids).
data.object.idstringyesPartner ID.
data.object.namestringyesPartner (company) name.
data.object.deletedbooleanyesWhether the partner is deleted. Always true for partner.deleted.
data.object.updatedAtstring (date-time)noLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids).
data.object.idstringyesPartner ID.
data.object.namestringyesPartner (company) name.
data.object.deletedbooleanyesWhether the partner is deleted. Always true for partner.deleted.
data.object.updatedAtstring (date-time)noLast 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.

FieldTypeRequiredDescription
data.companyIdstringyesCompany the event belongs to.
data.objectobjectyesLean representation of a partner (subcontractor). Fetch the full partner with costprofilesSubcontractor(ids).
data.object.idstringyesPartner ID.
data.object.namestringyesPartner (company) name.
data.object.deletedbooleanyesWhether the partner is deleted. Always true for partner.deleted.
data.object.updatedAtstring (date-time)noLast 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"
}
}
}