---
title: "Set Low Balance Webhook"
method: PUT
path: "/users/me/low-balance-webhook"
tags: ["General APIs with JWT"]
---

# Set Low Balance Webhook

`PUT /users/me/low-balance-webhook`

## Request

- Base URL: `https://lium.io/api`
- URL: `https://lium.io/api/users/me/low-balance-webhook`
- Auth: one of:
  - HTTP bearer
  - 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)

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

## Request body

- LowBalanceWebhookUpdateDto
  - `url` string, required: Public HTTPS URL that receives the signed balance events

## Response `200`

Successful Response

- LowBalanceWebhookDto
  - `url` string, nullable, required: The webhook URL, null when none is set
  - `secret` string, nullable: HMAC-SHA256 signing secret; returned only by the PUT that sets the URL

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-02** `79fee0230f5b`: 1 info
  - the endpoint scheme security `APIKeyHeader` was added to the API
- **2026-10-28** `b12c0cd2e20c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lium/apis/lium-backend-api/changes/users/me/low-balance-webhook/put.md)

---

[API](https://skmtc.dev/lium/apis/lium-backend-api.md) - [All operations](https://skmtc.dev/lium/apis/lium-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lium/apis/lium-backend-api/revisions/f5f94aa0bc8e?raw)