Register a webhook endpoint

Registers an HTTPS URL to receive signed events and returns its signing secret once. Store the
secret in a secrets manager; it cannot be read back. events is a list of event types to receive
(see the Webhooks section of the guide); omit it to receive every event. Up to 5 endpoints per
account.

Errors: 400 URL_REQUIRED | URL_INVALID | URL_SCHEME | URL_PRIVATE | URL_TOO_LONG | INVALID_EVENT | LIMIT_EXCEEDED.

{ "url": "https://store.example/webhooks/qasimha", "description": "Production store", "events": ["order.confirmed", "order.refunded"] }
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string | null
string | null
events
array of strings | null
events
Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json