Webhooks

Webhooks are not available yet. Today, order completion is detected by polling GET /orders/{reference}. Low-balance alerts are sent by email - see Notifications.

We are planning HTTP webhooks so you can receive events without polling. This page describes the planned shape; payloads and delivery may change before launch.

Planned events

Event	When it fires
`order.completed`	All codes for an order were delivered
`order.failed`	The order finished with no codes delivered
`order.partially_completed`	Some but not all codes were delivered
`balance.low`	A wallet balance crossed below the configured threshold

Draft payload shape

{
  "id": "evt_01H…",
  "type": "order.completed",
  "createdAt": "2026-06-02T11:05:00Z",
  "data": {
    "orderId": "b9f6f9a2-4d0a-4f5c-9a1e-7c2d8f3b6e10",
    "externalOrderCode": "O-12345",
    "status": "completed"
  }
}

Webhooks will be signed so you can verify authenticity. Registration (URL + secret) will be documented here when the feature ships.

Until webhooks launch

Poll orders after estimatedReadyAt - see Order lifecycle.
Use GET /wallet or the embedded wallet field on order responses for balance checks.
Subscribe to email low-balance alerts - see Notifications.

Notifications Node reference client

Get started

Core concepts

Migrate

Planned events

Draft payload shape

Until webhooks launch

​Planned events

​Draft payload shape

​Until webhooks launch

Planned events

Draft payload shape

Until webhooks launch