Update a webhook

Update an existing webhook. Change the URL to which event notifications are sent or the list of event types to be notified about.

You must specify at least one of these two. The fields that you don't specify are not updated.

For more information, see the guides: About webhooks and Manage webhooks.

Request

The new webhook URL for the given webhook

Path Parameters
Path Parameters

The ID of the webhook to update.

Request body
Body object

A valid webhook URL to which to send event notifications. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

A list of event types to subscribe to.

Response

The successfully updated webhook

Response body
Body object

The ID of the webhook.

The valid webhook URL that event notifications are sent to. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

The list of event types that you are subscribed to.

Was this page helpful?