webhooks:write permission.
Request
Headers
Path parameters
Request body
All body fields are optional. Send only the fields you want to change.Replacement list of event types to subscribe to. This fully replaces the current list — include all events you want, not just the new ones.
Supported events are
donation.created, donation.updated, subscription.created, subscription.updated, subscription.cancelled, subscription.payment_method_updated, contact.created, contact.updated, form.created, and form.updated.New status for the webhook. Accepted values:
ACTIVE or DISABLED. Setting to DISABLED stops event delivery without deleting the webhook.Response
200 — success
Returns the full updated webhook object. See List Webhooks for a description of all fields.400 — bad request
Returned when the request body is invalid — for example, ifurl is not a valid HTTPS URL or events is an empty array.
403 — forbidden
Returned when the webhook exists but belongs to a different merchant account.404 — not found
Returned when no webhook with the givenid exists under your merchant account.
Examples
Sample response (200)
To re-enable a previously disabled webhook, send
{"status": "ACTIVE"}. Event deliveries resume immediately for new events — past events that occurred while the webhook was disabled are not replayed.