Skip to main content
PATCH
/
agents
/
webhooks
/
{webhook_id}
Update Webhook
curl --request PATCH \
  --url https://api.cartesia.ai/agents/webhooks/{webhook_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Cartesia-Version: <cartesia-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "<string>",
  "secret": "<string>",
  "display_name": "<string>"
}
'
"<string>"

Authorizations

Authorization
string
header
required

Cartesia API key (sk_car_...). Get one at play.cartesia.ai/keys.

Headers

Cartesia-Version
enum<string>
required

API version header.

Available options:
2026-03-01
Example:

"2026-03-01"

Path Parameters

webhook_id
string
required

The ID of the webhook.

Body

application/json

Fields to update on a webhook.

url
string<uri>
required

The HTTPS endpoint Cartesia POSTs call events to.

secret
string

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

display_name
string

An optional name to identify the webhook.

Response

Webhook updated. Returns the ID of the updated webhook.

The ID of the updated webhook.