PATCH/organizations/{organizationId}/webhooks/{webhookId}

Update a webhook subscription

Updates URL, description, events, and state for a subscription.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenBearerAuthoptional

Stored only in this browser for the BearerAuth security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

organizationIdpath · stringrequired

Opaque organization identifier.

webhookIdpath · stringrequired

Request body

application/jsonrequired

urlstring · urioptional

descriptionstringoptional

eventsarray<string>optional

statusenumoptional

Values: "active" · "paused" · "disabled"

Responses

200application/json

Webhook updated.

{
  "id": "whk_01J8FD1M5T7Q9P2V4K6",
  "url": "https://hooks.acme.example/heyo",
  "description": "Acme production event receiver",
  "events": [
    "contact.created",
    "document.published",
    "export.failed"
  ],
  "status": "active",
  "signing_secret_last4": "4K6Z",
  "delivery_health": {
    "success_rate": 99.5,
    "failed_last_24h": 1,
    "last_delivery_at": "2026-09-03T11:05:00Z"
  },
  "created_at": "2026-06-17T12:12:00Z"
}

idstringoptional

urlstringoptional

descriptionstringoptional

eventsarray<string>optional

statusstringoptional

signing_secret_last4stringoptional

delivery_healthobjectoptional

created_atstring · date-timeoptional

curl --request PATCH \ 'https://api.demo.heyo.example/v3/organizations/org_01J8F1Q6N6VTX4E8W9R2D0A7B3/webhooks/whk_01J8FD1M5T7Q9P2V4K6' \ --header 'Content-Type: application/json' \ --data '{ "url": "https://hooks.acme.example/heyo/v2", "events": [ "contact.created", "contact.updated", "export.failed" ], "status": "active"}'

{ "id": "whk_01J8FD1M5T7Q9P2V4K6", "url": "https://hooks.acme.example/heyo", "description": "Acme production event receiver", "events": [ "contact.created", "document.published", "export.failed" ], "status": "active", "signing_secret_last4": "4K6Z", "delivery_health": { "success_rate": 99.5, "failed_last_24h": 1, "last_delivery_at": "2026-09-03T11:05:00Z" }, "created_at": "2026-06-17T12:12:00Z" }