Partially update a webhook by ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Object ID (UUID)

Body Params

Defines a webhook rule to an external server. The callback URL will receive a POST request with the related object's (e.g. Purchase for purchase.* webhooks) data in body when any of the events (see the description of events field below) it is configured to listen for are triggered. The payload object will additionally include an "event_type" field to indicate which event type (see the Webhook.events field) triggered the webhook.

Note that, as well as with the rest of dataset, test and live Webhooks are separate; test webhooks will not handle events caused by live Purchases, and vice-versa.

string
required
length ≤ 100

Arbitrary title of webhook

boolean
Defaults to false

Specifies this webhook should trigger on all event types. Either this or events is required.

events
array of objects
required
length ≥ 1

List of events to trigger webhook callbacks for. Either this or all_events is required.

url
required
length ≤ 500
Responses

404

No such object

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