Sign in

v1

latestOpenAPI 3.0.32026-07-264469137.7 KB
Webhooks

Update a webhook endpoint

Update an endpoint's name, URL, or subscribed events. Only the fields you send are changed. Requires the webhooks:write scope.

patch/v1/webhooks/endpoints/{endpoint_id}

Path parameters

endpoint_idstring required

The webhook endpoint's ID.

Request body

namestring nullable

A new label for the endpoint.

urlstring uri nullable

A new HTTPS delivery URL.

event_typesstring[] nullable

Replace the subscribed events. At least one if provided.

Example request

{
  "name": "Production events",
  "url": "https://api.example.com/webhooks/bachs",
  "event_types": [
    "collection.succeeded"
  ]
}

Response

The updated endpoint.

endpoint_idstring required

Unique identifier for the endpoint.

namestring required

A label for the endpoint.

urlstring uri required

The HTTPS URL events are delivered to.

enabledboolean required

Whether the endpoint is active and receiving events.

event_typesstring[] required

The events this endpoint is subscribed to.

created_atstring required

When the endpoint was created, in UTC.

updated_atstring required

When the endpoint was last updated, in UTC.

Example response

{
  "endpoint_id": "whe_1a2b3c4d5e",
  "name": "Production events",
  "url": "https://api.example.com/webhooks/bachs",
  "enabled": true,
  "event_types": [
    "collection.succeeded",
    "collection.failed"
  ],
  "created_at": "2026-04-27T12:00:00Z",
  "updated_at": "2026-04-27T12:00:00Z"
}