Skip to main content
PATCH
Update Webhook Endpoint
Only provided, non-null fields are changed. Sending null does not clear a field, and an empty object is a no-op. The signing secret is not returned.

Path Parameters

string
required
The customer’s external ID (starts with cus_)
string
required
The webhook endpoint’s external ID (starts with wh_)

Request Body

string
New HTTPS webhook delivery URL
array
Replacement list of event subscriptions. This replaces the entire existing list. An empty array removes all subscriptions without deleting the endpoint.
string
New description (maximum 255 characters)
Supported event names are listed in Webhook Events.

Response

string
Webhook endpoint identifier (starts with wh_)
string
Always returns "webhook_endpoint"
string
The webhook delivery URL
array
Subscribed event types
string
Webhook description, or null
string
ISO 8601 creation timestamp
string
ISO 8601 last-update timestamp
string
Identifier of the actor that created the endpoint, or null
string
Identifier of the actor that last updated the endpoint, or null
string
Timestamp of the most recent successful delivery, or null
string
Deletion timestamp. This is null for resources updated by this endpoint.

Response Example