LuniPay Docs

API Reference · Webhook Endpoints

Create a webhook endpoint

Registers a new webhook endpoint. The signing secret is returned once.

POST/v1/webhook-endpoints

The `url` must be a public HTTPS URL. The `signing_secret` field is the only time you can read the plaintext secret. Store it in your server-side secret store — LuniPay encrypts it at rest and never shows it again.

Returnswebhook_endpoint object

Body parameters

urlstringRequired

Public HTTPS URL that will receive deliveries. For local development, register an ngrok or Cloudflare Tunnel URL.

enabled_eventsarrayRequired

Event types to subscribe to. Use `["*"]` to receive everything.

descriptionstring

Optional dashboard label.

Errors

400
parameter_invalid_url

`url` is missing, not HTTPS, malformed, or points at a local/private host.