Skip to main content
POST
Create webhook endpoint

Authorizations

Authorization
string
header
required

Store-scoped API key. Prefix with sk_live_. Example: Authorization: Bearer sk_live_EXAMPLE_DO_NOT_USE

Body

application/json
url
string<uri>
required

Required. HTTPS URL on your server that accepts POST requests. Must respond with HTTP 2xx when delivery succeeds.

name
string
default:Default

Optional. Label for this endpoint in your dashboard. Defaults to "Default" if omitted.

Minimum string length: 1
events
string[]

Optional. Which events to send (e.g. invoice.paid, invoice.expired). Defaults to standard invoice lifecycle events if omitted.

Response

Webhook endpoint created

Response immediately after creating a webhook endpoint. The signing secret is shown only once.

id
string

Webhook endpoint ID (wh_...).

Pattern: ^(inv_|txn_|plink_|wh_|whd_|evt_|int_)[0-9a-z]{20,32}$
name
string

Endpoint display name.

url
string<uri>

Destination URL for webhook deliveries.

secret
string

Signing secret. Store this securely; it is shown only at creation.

Example:

"0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef"

secret_prefix
string

Prefix of the secret for later identification.

Example:

"01234567"

events
string[]

Subscribed event types.

message
string

Reminder to save the secret before leaving the creation flow.

Example:

"Save this secret now. It will not be shown again."