Allows an affiliated partner to update the settings for receiving webhook notifications. This endpoint enables a partner to set or reset the URL where webhook notifications will be sent.
Headers
PartnerApiKey (string) - API key associated with the partner.
Partner API Key Required
Requires
partner-api-keyfor authentication to ensure only authorized partners can access this data.See 🔑 API Key Generation Guide for getting your API key
Body:
- url (string or null) - The
URLwhere webhook notifications will be sent. To reset the webhookURL, a value of null can be sent.
Example
{
"url": "https://some-webhook-endpoint.url",
}
Use cases
Setting a Webhook URL for Notification Delivery
A partner wants to start receiving webhook notifications at a specific URL. They use this endpoint to set the url to their desired endpoint, allowing them to receive notifications directly.
Resetting the Webhook URL
If a partner decides they no longer want to receive webhook notifications, they can reset the url by sending null in the body. This action stops the delivery of webhook notifications.
Updating the Webhook URL
A partner changes their server or endpoint and needs to update the URL where webhook notifications are sent. They use this endpoint to provide a new url.