Skip to main content
POST
cURL

Authorizations

Authorization
string
header
default:$CARTESIA_API_KEY
required

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

Headers

Cartesia-Version
enum<string>
default:2026-03-01
required

API version header.

Available options:
2026-03-01
Example:

"2026-03-01"

Body

application/json
url
string<uri>
required

The HTTPS endpoint Cartesia POSTs call events to.

secret
string
required

A shared secret. Cartesia returns it in the X-Webhook-Secret header on every delivery so your endpoint can verify the request.

display_name
string

An optional name to identify the webhook.

Response

200 - application/json

Webhook created. The response includes the secret — this is the only time it is returned.

A webhook including its secret. The secret is only returned when the webhook is created.

id
string
required

The ID of the webhook.

url
string<uri>
required

The HTTPS endpoint call events are delivered to.

secret
string
required

The shared secret. Returned only on creation.

created_at
string<date-time>
required

When the webhook was created.

updated_at
string<date-time>
required

When the webhook was last updated.

display_name
string | null

The webhook's display name, or null if unset.