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.

Query Parameters

fields[webhook-subscriptions]
enum<string>[]
Available options:
url,
events,
secret,
enabled,
consecutive_failures,
created_at,
updated_at,
disabled_at

Body

application/json
url
string<uri>
required

The webhook endpoint URL.

Maximum string length: 2048
events
enum<string>[]
required

The event types to subscribe to.

Minimum array length: 1

Each event type must be a valid WebhookEventType.

Available options:
verification.pending,
verification.successful,
verification.failed,
verification.cancelled,
verification.expired,
verification.error,
verification.authentication_ready,
verification.authentication_link_sent,
invoice.reading,
invoice.processed,
invoice.failed,
invoice.invalid,
webhook.test

Response

WebhookSubscriptionResource

data
WebhookSubscriptionResource · object
required