Sign in

v1

latestOpenAPI 3.0.32026-08-0425108247.7 KB
Webhooks

Update a webhook endpoint

Updates webhook endpoint metadata and delivery settings.

patch/webhook-endpoints/{endpointId}

Path parameters

endpointIdstring required

Webhook endpoint identifier.

Webhook endpoint identifier.

Request body

enabled_eventsstring[]

Product event types to deliver to this endpoint.

namestring nullable

Optional endpoint label.

status'active' | 'disabled'

Endpoint status.

urlstring

HTTPS receiver URL.

Response

Updated webhook endpoint.

Example response

{
  "data": {
    "created_at": "2026-05-14T08:00:00.000Z",
    "delivery_scope": {
      "actor_workspace_membership_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
    },
    "id": "01jzn7e61x3a7v9h2r7t2m3q4p",
    "updated_at": "2026-05-14T08:00:00.000Z",
    "workspace_id": "01jzn7e61x3a7v9h2r7t2m3q4p"
  }
}