PATCHwebhooks:write

Update webhook

Update webhook.

Request

PATCHhttps://api.cymatics.tech/v1/webhooks/{webhook}

Send your key as Authorization: Bearer cym_test_…. Requires the webhooks:write scope. Test keys read the simulator; live keys read your paired Cymos.

`webhook`requiredstring	pathWebhook idSDK and CLI: `webhook_id`
`Idempotency-Key`string	headerReplays the first response for an identical request within the project and mode.

Request body

`url`string (uri)	body
`events`string[]	body
`enabled`boolean	body

application/json

{
  "url": "https://example.com/hooks/cymo",
  "events": [
    "bed.exited"
  ],
  "enabled": true
}

Response

200 · application/json

{
  "data": {
    "object": "webhook",
    "id": "wh_01",
    "url": "https://example.com/hooks/cymo",
    "events": [
      "bed.exited"
    ]
  },
  "meta": {
    "request_id": "req_01",
    "project_id": "proj_demo",
    "livemode": false,
    "generated_at": "2026-10-24T23:55:30.000Z"
  }
}

Errors

429rate_limit_exceeded: Too many requests this minute for the key (or twice that across the project), or too many open streams for the project. Retry after the seconds in Retry-After.quota_exceeded: A live key's project has used its monthly live-hour cap. There is no Retry-After. Don't retry; raise the live-hour cap in the dashboard. Headers: Retry-After, RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset.
503live_unavailable: This operation has no live data for this project yet (for example, no paired Cymo covers it). Don't retry the same request; pair a Cymo that covers it, or build against a test key.service_unavailable: A dependency, such as API key verification, is unreachable, or the project is busy with another write. Retry after the seconds in Retry-After, with backoff.
4XXInvalid request, credential, permission or revision.
defaultError with a stable code and request ID.

Every error is a { error, meta } envelope with a stable code. See Errors for each code and whether to retry.

Call it

TypeScript · @cymos/sdk

import { Cymo } from "@cymos/sdk";

const cymo = new Cymo({ apiKey: process.env.CYMO_API_KEY! });

const { data, meta } = await cymo.webhooks.update({
  webhook_id: "wh_01",
  url: "https://example.com/hooks/cymo",
  events: [
    "bed.exited"
  ],
  enabled: true
});

terminal · cymatics CLI

$ cymatics webhooks update --webhook-id wh_01 --input body.json --json

curl

curl -X PATCH "https://api.cymatics.tech/v1/webhooks/wh_01" \
  -H "Authorization: Bearer $CYMO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/hooks/cymo","events":["bed.exited"],"enabled":true}'

The SDK takes path parameters and body fields in one object. The CLI reads the body from --input, a JSON file or - for stdin.

MCP tool

update_webhook({
  webhook_id: "wh_01",
  input: {
    url: "https://example.com/hooks/cymo",
    events: [
      "bed.exited"
    ],
    enabled: true
  }
})

The MCP tool update_webhook calls this operation with your key. It takes the request body as input.