Agent-readable docs index: /llms.txt. Full docs in one file: /llms-full.txt. Download /docs.zip to grep all markdown files locally.

Update Webhook

Update a destination — pause/resume, retune filters, change the URL, or rotate the secret. See Webhooks.
path idstringrequired
Destination ID (whk_…).
body urlstring
New HTTPS endpoint.
body eventTypesstring[]
Replace the event-type allow-list (unknown types are rejected with 400). Pass null to clear it (deliver all types).
body enabledboolean
Pause (false) or resume (true) delivery. Pausing does not drop events — events that occur while paused are queued and delivered when you re-enable.
body rotateSecretboolean
Rotate to a new generated signing secret, returned as secret in the response. The previous secret stays valid for a short rollover window so in-flight deliveries still verify. (To set a specific secret, create a new destination.)
body namestring
Rename the destination.
sandboxId (scope) is immutable — set it at create; it can't be changed here. The current signing secret is re-fetchable any time via GET /api/webhooks/{id}/secret.
Response example
{
  "id": "whk_3f9a2c",
  "name": "prod",
  "url": "https://app.example.com/oc-webhook",
  "eventTypes": ["sandbox.stopped", "sandbox.ready"],
  "sandboxId": null,
  "enabled": true,
  "hasSecret": true,
  "createdAt": "2026-06-24T12:00:00Z",
  "updatedAt": "2026-06-24T12:05:00Z"
}