Webhook Events

Order Completed

A notification sent when an order is closed (fully paid).

Required scope: business/orders:read

postWebhookorder.completed

Headers

webhook-signaturestring required

An HMAC signature of the payload used to verify the webhook came from Yoco.

Payload

business_idstring required
order_idstring required
event_typestring required

Example payload

{
  "business_id": "f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1",
  "event_type": "order.completed",
  "order_id": "e13ed7f6-56a5-42f4-be6b-f87063ffd8f3"
}

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.