v1

latestOpenAPI 3.0.12026-07-2696152184.1 KB
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}

Path parameters

webhook_idstring required

The ID of the webhook.

Headers

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

API version header.

Request body

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.

Response

Webhook updated. Returns the ID of the updated webhook.

string required

The ID of the updated webhook.