CompuDime API docs

Reference / Schemas

WebhookDelivery

One event sent, or to be sent, to a receiver.

Type: object.

NameTypeDescription
attempts requiredintegerAttempts made so far.
createdAt requiredstring (date-time)When the event was queued.
event requiredstringThe event: an order event or webhook.test.
id requiredstringThe delivery id: id in the body and X-CompuDime-Delivery.
state requiredstringpending (waiting for its first attempt), failed (an attempt failed; the next one is at nextAttemptAt), delivered (your receiver answered 2xx), or dead (every retry failed; the store owner can send it again from the console).
updatedAt requiredstring (date-time)When the delivery last changed.
deliveredAtstring (date-time)When your receiver accepted it; absent until then.
lastErrorstringWhy the last attempt failed; absent once delivered.
lastStatusintegerThe HTTP status your receiver answered on the last attempt; absent when no answer came (a connection failure or a timeout).
nextAttemptAtstring (date-time)When the next attempt is due; absent once delivered or dead.
orderIdstringThe order it is about; absent on a test event.

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