Skip to main content
PATCH
Update Webhook Endpoint
Changes the URL, the subscription list, or the description of an active endpoint. Requires write access on the webhooks scope. The signing secret is unaffected and is never returned. Only fields you send are changed, and a field sent as null is ignored, not cleared. So a description cannot be removed once it is set; you can only replace it with different text. An empty body is accepted and returns the endpoint unchanged. A key this endpoint does not accept is rejected with 422. Event names are validated before the endpoint is looked up, so an invalid event name on an unknown endpoint id returns 422, not 404.

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 delivery URL. Must use https and include a host, and is normalised the same way as on create.
array
Replacement subscription list. It replaces the whole list instead of adding to it, so send every event you still want. An empty array is accepted and leaves the endpoint subscribed to nothing; it keeps existing but receives no further deliveries.Valid names: payin.received, payin.returned, payout.created, payout.completed, payout.failed, transfer.completed, transfer.failed, account.created, account.updated, payout_destination.updated
string
New description (maximum 255 characters). Sending null does not clear the existing one.

Response

string
Webhook endpoint identifier (starts with wh_)
string
Always returns "webhook_endpoint"
string
Delivery URL, as stored after normalisation
array
Subscribed event types after the update
string
Description, or null
string
ISO 8601 timestamp when created
string
ISO 8601 timestamp when last updated
string
Identifier of the actor that created the endpoint, or null
string
Identifier of the actor that last updated the endpoint, or null
string
Reserved. Always null. Hop does not record delivery times on the endpoint today.
string
Deletion timestamp. Always null here.

Errors

Request Example

Response Example