Skip to main content
POST
Create a webhook endpoint

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Headers

Idempotency-Key
string

A unique key per operation (a UUID works). Retrying with the same key returns the original response.

Body

application/json
url
string<uri>
required

HTTPS URL that receives deliveries.

events
string[]
required

Events to receive, such as payment.confirmed and invoice.finalized.

Example:

Response

Endpoint created, including the signing secret.

The newly created endpoint, with the signing secret (secret), shown only here.

id
string<uuid>
url
string<uri>

URL that receives deliveries.

events
string[]

Subscribed events. Any emitted event can be subscribed to by name, including ones without a documented payload yet.

isActive
boolean

Whether the endpoint is receiving deliveries.

createdAt
string<date-time>
secret
string