Sign in
Webhooks

Update an existing webhook subscription.

Partially updates an existing webhook subscription using HTTP PATCH.

Supported Updates:

  • Change the webhook URL
  • Enable or disable the subscription
  • Regenerate the secret key

Note: Event types cannot be changed after creation. To update event types, delete and recreate the subscription.

patch/webhooks/{id}

Path parameters

idstring uuid required

Request body

urlstring uri nullable
eventsstring[] nullable
isActiveboolean nullable
regenerateSecretboolean
isTestModeboolean nullable

Response

Webhook updated successfully

idstring uuid
urlstring nullable
eventsstring[] nullable
isActiveboolean
createdUtcstring date-time
updatedUtcstring date-time
disabledReasonstring nullable
secretstring nullable
isTestModeboolean