Update a webhook endpoint
Changes an endpoint's URL, description, subscribed event types, or whether it is disabled. Fields you leave out keep their values, and `event_types` replaces the whole list rather than adding to it; an empty list means every event type. A new URL is checked exactly as at creation. The signing secret never changes. While an endpoint is disabled, events are still recorded but nothing is delivered to it, and deliveries already queued for it are marked failed rather than held.
Changes an endpoint's URL, description, subscribed event types, or whether it is disabled. Fields you leave out keep their values, and event_types replaces the whole list rather than adding to it; an empty list means every event type. A new URL is checked exactly as at creation. The signing secret never changes. While an endpoint is disabled, events are still recorded but nothing is delivered to it, and deliveries already queued for it are marked failed rather than held.
Authorization
secretKey Your secret key: sk_live_… or sk_test_….
In: header
Path Parameters
The webhook endpoint's id, which starts with wh_.
^wh_[0-9a-f]{32}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X PATCH "https://example.com/webhooks/wh_3f2b8c1e9a4d4e7b8c2a1d5e6f7a8b9c" \ -H "Content-Type: application/json" \ -d '{}'{ "object": "webhook", "webhook_id": "wh_3f2b8c1e9a4d4e7b8c2a1d5e6f7a8b9c", "url": "http://example.com", "description": "string", "event_types": [ "payment.succeeded" ], "disabled": true, "livemode": true, "created_at": "2019-08-24T14:15:22Z"}List webhook endpoints GET
Lists every webhook endpoint in the key's mode, newest first, so you can see which of them is subscribed to what. This list is not paginated: `has_more` is always `false` and `next_cursor` always `null`. Signing secrets are not included; read one with `GET /webhooks/{id}/secret`.
Retrieve an event GET
Returns one event, with the object it happened to in `data`. Its id is the value a delivery carries in its `webhook-id` header, so a handler can read the event back from the API before acting on it. Only events belonging to the key's merchant and mode are visible.