CompuDime API docs

Reference / Schemas

WebhookReceiver

A receiver of your integration. Never its secret.

Type: object.

NameTypeDescription
active requiredbooleanfalse when the store owner or CompuDime turned it off: nothing is sent to it, and a test event is 409 webhook_inactive.
createdAt requiredstring (date-time)When it was registered.
events requiredarray of stringThe order events it is subscribed to.
id requiredstringThe receiver's id: the webhookId of the other receiver operations, and data.webhookId of a test event.
mode requiredstringThe mode of the key it belongs to. A test receiver gets only the test events you send it. One of: live, test.
secretPrefix requiredstringThe first characters of the signing secret (whsec_ and six more), to tell secrets apart. Never more of it.
updatedAt requiredstring (date-time)When it last changed.
url requiredstringWhere CompuDime posts the events.
lastDeliveryWebhookDeliveryIts newest delivery; absent when nothing was sent to it yet.
secretRotatedAtstring (date-time)When its secret was last rotated; absent if never.

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