Skip to navigation
Checkout API referenceWebhooks

Update webhook

Replace the events sent to a registered webhook.

The webhook keeps its ID, URL and secret.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The ID of the webhook to update

Request

This endpoint expects an object.
eventslist of enumsRequired

The event types to send to the webhook, each listed once. Replaces the webhook’s current event types. An unknown or repeated type returns 400 and leaves the webhook unchanged.

Allowed values:

Response

This endpoint returns an object.
idstring
Unique identifier for the registered webhook
namestring
Name of the webhook
urlstring
URL where webhook events will be sent
eventslist of enums
Events sent to the webhook
Allowed values:
modeenum
Operating mode of the webhook
Allowed values:

Errors

400
Invalid Input Error
403
Permission Error
404
Not Found Error
500
Server Error