Create a webhook endpoint
Webhooks
Create a webhook endpoint
Creates a new webhook endpoint. Returns the endpoint with its signing secret.
Important: The signing secret is only shown once. Store it securely.
POST
Create a webhook endpoint
Authorizations
Server-side secret key header. Format: sk_live_* (production) or sk_test_* (testing).
Body
application/json
Response
Webhook endpoint created
Example:
"00000000-0000-4000-8000-000000000123"
Available options:
webhook_endpoint Available options:
enabled, disabled Available options:
verification.state_changed, verification.completed, verification.failed, verification.canceled, verification.expired Example:
[
"verification.completed",
"verification.failed"
]Display-safe prefix of the endpoint signing secret.
Example:
"whsec_abcd1234"
Environment that owns the endpoint.
Available options:
test, live Consecutive failed delivery attempts for this endpoint.
Required range:
x >= 0HMAC signing secret (only shown once)
Example:
"whsec_abc123xyz"