Skip to main content
POST
Create a webhook subscription

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
url
string<uri>
required

HTTPS endpoint that will receive webhook deliveries.

events
string[]
required

Event keys to subscribe to. Provide * to listen for all events.

Minimum array length: 1
description
string

Optional description shown in dashboards (max 512 characters).

customHeaders
object

Optional headers added to every webhook request.

secret
string

Provide a custom signing secret (minimum 16 characters).

Response

201 - application/json

Webhook subscription created successfully.

subscription
object
required

Configuration for a webhook endpoint that receives paywall events.