Webhooks Reference

Use webhooks to receive real-time notifications from Lirium when certain events occur, such as when an order is confirmed or a customer's state changes.

Webhook Payload Structure

All webhook event payloads share common properties. Each event type also contains properties unique to that event.

Common Properties

Key	Type	Description	Notes
`id`	string	Unique event identifier
`action`	string	The event type that triggered the webhook	See supported actions below
`[entity]`	object	The entity that triggered the event, exactly as you would receive it from its Details endpoint	`customer` or `order` data

Supported Actions

Action	Description
`order-closed`	An order has been completed or cancelled
`order-updated`	An order's status has changed
`partner-order-created`	A partner order has been created
`partner-order-closed`	A partner order has been completed or cancelled
`partner-order-updated`	A partner order's status has changed
`customer-state-changed`	A customer's state has changed
`customer-requirement-rejected`	A customer's KYC requirement was rejected
`incoming-funds`	Funds have been received at a receiving address

Example Payload

{
  "id": "evt_abc123def456",
  "action": "order-closed",
  "order": {
    "id": "ord_xyz789",
    "state": "closed",
    "customer_id": "cust_123456",
    ...
  }
}

Event Type Documentation

For detailed payload examples for each event type, see: