Overview
Update an existing webhook subscription to modify its endpoint URL, event types, description, or status. You can update any combination of these fields - only the fields you include in the request will be modified.This endpoint requires authentication using your API key in the
X-Ivy-Api-Key
header.Request Parameters
The ID of the webhook subscription to update.
The new URL where webhook events will be sent. Must be a valid HTTPS URL.
Array of event types to subscribe to. Available event types include:
checkout_session.completed
- When a checkout session is successfully completedcheckout_session.expired
- When a checkout session expirespayout.paid
- When a payout is successfully processedpayout.failed
- When a payout failsrefund.succeeded
- When a refund is successfully processedrefund.failed
- When a refund fails
New description for the webhook subscription to help identify its purpose.
The new status for the webhook subscription. Valid values:
active
, inactive
.Example Request
Example Response
Partial Updates
You can update individual fields without affecting others. For example, to only change the description:Error Responses
Status Changes
When you change a webhook subscription’s status:active
: Webhook events will be sent to the endpoint URLinactive
: Webhook events will not be sent, but the subscription is preserved
Setting a webhook to
inactive
is useful for temporarily disabling webhooks without deleting them.