Checkout API ReferenceWebhooks

Register Webhook

Register a new webhook endpoint to receive event notifications.

There is a limit of 5 webhooks per account. To prevent potential issues, we recommend registering only one webhook. If you need to delete any extra webhooks, see Delete a webhook.

The secret will be used to verify the event origin. It is important to save this value for future use since it is provided only once.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
namestringRequired
The name you want to give to the webhook you are registering.
urlstringRequired

The URL where the webhook events will be sent. Refer to the URL created in Step 1: Create the webhook endpoint.

Response

This endpoint returns an object.
idstring
Unique identifier for the registered webhook
modeenum
Operating mode of the webhook
Allowed values:
namestring
Name of the webhook
secretstring
Secret key for webhook verification. Important to save this value for future use since it is provided only once.
urlstring
URL where webhook events will be sent

Errors