Webhooks

Update Webhook

Update a webhook's url, secret, or display_name. Omit secret to leave the existing secret unchanged.

patch/agents/webhooks/{webhook_id}

Request

Base URL
https://api.cartesia.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/cartesia/apis/cartesia-api/docs/agents/webhooks/:webhook_id/patch.ts
A function with typed inputs. Its response is checked against the schema.

webhook_idstring required

The ID of the webhook.

Cartesia-Version'2026-03-01' date required

Example:2026-03-01

API version header.

urlstring uri required

The HTTPS endpoint Cartesia POSTs call events to.

secretstring

A new shared secret. Omit to leave the existing secret unchanged.

display_namestring

An optional name to identify the webhook.

Webhook updated. Returns the ID of the updated webhook.

string required

The ID of the updated webhook.

No recorded changes to this operation across all 1 revision of this API.