Update a webhook endpoint
Updates the endpoint’s URL, description, event type subscriptions, or
enabled state. All fields are optional; omit a field to leave it unchanged.
disabled and status are two representations of the same flag — pass one
or the other, not both. The signing secret is not included in the response.
Send an Idempotency-Key header.
Authorizations
A merchant secret key (sk_…) sent as Authorization: Bearer <key>.
Headers
Required. A unique key that makes retries safe: the same key with the same request body returns the original response instead of repeating the operation.
255Path Parameters
The webhook endpoint id (whe_…).
Body
All fields are optional; omit any field to leave it unchanged.
New destination URL.
New description, or null to clear it.
Replacement set of event type subscriptions. Accepts the same wildcard forms as create.
true disables the endpoint; false re-enables it. Mutually exclusive with status.
Explicit status. active enables the endpoint; disabled pauses it. Mutually exclusive with disabled.
active, disabled Response
The updated webhook endpoint. The signing secret is not included.
webhook_endpoint Current lifecycle state. active means the endpoint is receiving deliveries.
disabled means it is paused by the merchant. deleted means it has been
soft-deleted. error means deliveries were disabled after repeated
failures.
active, disabled, deleted, error true when status is disabled; false otherwise.
Unix epoch seconds.
Unix epoch seconds when the signing secret was last rotated. Null until the first rotation after creation.
Unix epoch seconds when the endpoint was deleted. Null while active.

