Webhook Events

Balance low event

Balance billing only. The balance dropped below the low-balance alert set on auto top-up (alertBelowCents on GET /v1/balance/auto-recharge).

When it fires

Once per drop below the threshold; a balance back at or above it re-arms the next one. It does not fire when an auto top-up is already covering the drop, and never when no alert is set.

Who receives it

It belongs to the billing owner, not to a profile or account: endpoints scoped with profileIds or accountIds do not receive it. Restricted keys need the money resource group.

How to act

Send the user to fundingUrl (Billing with the Add funds drawer open), or add funds through the API.

postWebhookbalance.low

Payload

idstring required

Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery. It identifies the event only, never an account or other resource.

testboolean

Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.

event'balance.low' required
fundingUrlstring uri required

Dashboard link that opens the Add funds drawer in Billing.

timestampstring date-time required

UTC time at which Zernio generated this event. Retries and redeliveries keep the original value.

Response

Webhook received successfully

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.