webhooks

Register a webhook endpoint (verbose path)

Changed on

Alias for POST /webhooks. Returns full endpoint object including signing secret.

post/webhooks/endpoints

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/webhooks/endpoints
  • 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