webhooks

Register a webhook endpoint

Changed on

Registers a new webhook endpoint to receive Stripe-style signed event notifications. The response includes a secret (prefixed whsec_) used to verify the X-SZL-Signature header on every delivery. Store it securely — it is only returned once.

post/webhooks

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/webhooks
  • Auth: one of:
    • HTTP bearer
    • API key in cookie session

Request body

urlstring uri required

The HTTPS endpoint that will receive webhook deliveries

descriptionstring

Human-readable label for this endpoint

Response

Webhook endpoint registered

successboolean

Changes