Create Subscription

Time	Status	User Agent
Retrieving recent requests…

Create a webhook subscription to receive real-time notifications when events occur in your Lirium account.

Request

POST /webhooks/subscriptions

Request Body

Field	Type	Required	Description
url	string	Yes	The HTTPS URL where webhook events will be sent
events	array	Yes	List of event types to subscribe to

Supported Event Types

order-closed - Order has been completed or cancelled
order-updated - Order status has changed
partner-order-created - Partner order has been created
partner-order-closed - Partner order has been completed or cancelled
partner-order-updated - Partner order status has changed
customer-state-changed - Customer state has changed
customer-requirement-rejected - Customer KYC requirement was rejected
incoming-funds - Funds have been received at a receiving address

Example Request

{
  "url": "https://your-server.com/webhooks/lirium",
  "events": ["order-closed", "order-updated", "customer-state-changed"]
}

Example Response

{
  "id": "sub_abc123def456",
  "url": "https://your-server.com/webhooks/lirium",
  "events": ["order-closed", "order-updated", "customer-state-changed"],
  "created_at": "2025-01-05T12:00:00Z"
}

Security

All webhook calls include a JWT signature in the X-JWT-SIGNATURE header. See Webhooks Signature for verification details.

Your endpoint must:

Use HTTPS
Respond with a 2xx status code within 30 seconds
Be idempotent (handle duplicate deliveries gracefully)