Skip to main content
POST
Register a voice quality webhook

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /api/v1.1/auth/token.

Headers

Idempotency-Key
string

Any string unique to this logical request. On a retry with the same key and the same request body, the original response is replayed verbatim (with an Idempotency-Replayed: true response header) instead of the action repeating. Reusing the key with a different body or on a different route returns 409 IDEMPOTENCY_KEY_REUSED. A replay attempted while the original call is still in flight returns 409 CONFLICT. Optional — omit it and the endpoint behaves exactly as it would otherwise.

Example:

"a1b2c3d4-idem-key-001"

Body

application/json
url
string
required

HTTPS URL on port 443.

Maximum string length: 2048
Example:

"https://partner.example.com/hooks/voice-quality"

events
enum<string>[]

Events to receive. Only voice.test.completed exists today, and it is the default.

Available options:
voice.test.completed
description
string
Maximum string length: 200
Example:

"Voice quality demo"

Response

Registered. signingSecret is shown only in this response.

success
boolean
Example:

true

data
object