CompuDime API docs

Reference / Schemas

OrderWebhookEvent

The body of one order webhook delivery. New keys may be added; ignore the ones you do not know.

Type: object.

NameTypeDescription
createdAt requiredstring (date-time)When the order changed state and the delivery was queued.
data requiredOrderWebhookData
id requiredstringThe delivery id, also sent as X-CompuDime-Delivery. Retries and redeliveries carry the same id: deduplicate on it.
type requiredstringThe event. One of: order.dispatched, order.parked, order.picked, order.out_for_delivery, order.delivered, order.completed, order.canceled.

Other fields can appear later. Ignore the ones you do not know.