General APIs with JWT

Set Low Balance Webhook

Set the webhook URL (public HTTPS only) and get a new signing secret; any earlier secret stops working.

put/users/me/low-balance-webhook

Request

Base URL
https://lium.io/api
Auth
- HTTP bearer
- or API key in header X-API-Key
TypeScript
https://skmtc.dev/lium/apis/lium-backend-api/docs/users/me/low-balance-webhook/put.ts
A function with typed inputs. Its response is checked against the schema.

urlstring required

Public HTTPS URL that receives the signed balance events

Successful Response

urlstring nullable required

The webhook URL, null when none is set

secretstring nullable

HMAC-SHA256 signing secret; returned only by the PUT that sets the URL

Nov 2, 202679fee0230f5b Revision changes
- info
  the endpoint scheme security APIKeyHeader was added to the API
Oct 28, 2026b12c0cd2e20c Revision changes
- info
  endpoint added