Create Webhook

Registers a URL to receive one event type for the authenticated account. The
secret is used to sign outbound deliveries and is never returned by any
endpoint - store it when you register.

One URL may be registered once per event, and an account has a fixed maximum
number of webhooks; both are reported as 400.

Body Params

Webhook Details

string
enum
required

Event is the single event this URL receives. Register one webhook per
event you want delivered.

Allowed:
string
required

Secret signs every delivery so you can verify it came from us. It is never
returned by any endpoint - store it now.

string
required

Url is the HTTPS endpoint deliveries are POSTed to.

Responses

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