Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain a token via your identity provider and pass it in the Authorization: Bearer <token> header.

Scopes

REAL_CALL_API_KEYS_WEBHOOKS_ACCESS

Body

application/json

Create an organization webhook.

name
string
required
Minimum string length: 1
Example:

"Production alerts"

url
string
required

Destination URL. Must use HTTPS and must not contain credentials (user:password@).

Pattern: ^https://[^@/?#]+([/?#]|$)
Example:

"https://example.com/webhooks"

events
string[]
required

Event types that trigger this webhook. stream.concluded (a call reached its final conclusion) is the only event sent today; other values are accepted but never trigger a delivery.

Minimum array length: 1
apiKey
string

Optional shared secret, forwarded on delivery as the outbound X-Api-Key header.

Minimum string length: 1
Example:

"s3cr3t"

Response

The created webhook, including its one-time public key.

A newly created webhook. Only this response contains publicKey; store it, because it cannot be retrieved again.

id
string
required

Identifier of the webhook.

Example:

"2nYn7qqkM5678Ks99ykvmZAr7pz"

organizationId
string
required

Owning organization.

Example:

"2nYn7qqkM5678Ks99ykvmZAr7pz"

name
string
required

Display name.

Example:

"Production alerts"

url
string
required

Destination URL. HTTPS only.

Example:

"https://example.com/webhooks"

events
string[]
required

Event types that trigger this webhook. stream.concluded (a call reached its final conclusion) is the only event sent today; other values are accepted but never trigger a delivery.

enabled
boolean
required

Whether the webhook is active. A disabled webhook receives no deliveries until it is enabled again.

Example:

true

createdAt
string<date-time>
required
Example:

"2026-07-01T12:00:00Z"

updatedAt
string<date-time>
required
Example:

"2026-07-01T12:00:00Z"

publicKey
string
required

Ed25519 public key (base64) for verifying signed payloads. Returned once, on creation only, and never again. Store it securely.

Example:

"MCowBQYDK2VwAyEA..."