Skip to main content
POST
Create a webhook endpoint

Autorizaciones

Authorization
string
header
requerido

A Bearer token. Create keys in the portal under Settings > API keys (https://app.ryvo.so/developers). The token has the form ryvo_live_<64 hex characters> and is shown once.

Header: Authorization: Bearer ryvo_live_...

Cuerpo

application/json
url
string<uri>
requerido

Must be https and public. Unique per account.

Maximum string length: 500
Ejemplo:

"https://crm.acme.example/hooks/ryvo"

events
enum<string>[]
requerido
Minimum array length: 1
Opciones disponibles:
conversation.started,
conversation.ended,
analysis.ready,
call.initiated,
call.completed,
call.failed
Ejemplo:
accept_per_event_billing
boolean

Required from the sixth endpoint on, to accept the per-event charge.

Respuesta

The endpoint, with its signing secret.

id
string<uuid>
requerido
Ejemplo:

"7f8e9d0c-1b2a-4c3d-8e4f-5a6b7c8d9e0f"

url
string<uri>
requerido
Ejemplo:

"https://crm.acme.example/hooks/ryvo"

events
enum<string>[]
requerido
Opciones disponibles:
conversation.started,
conversation.ended,
analysis.ready,
call.initiated,
call.completed,
call.failed
Ejemplo:
is_active
boolean
requerido
consecutive_failures
integer
requerido
Ejemplo:

0

auto_disabled_at
string<date-time> | null
requerido

Set when Ryvo switched the endpoint off after repeated exhausted deliveries.

auto_disabled_reason
string | null
requerido
previous_secret_expires_at
string<date-time> | null
requerido

After a rotation, until when the previous secret still signs.

created_at
string<date-time>
requerido
updated_at
string<date-time>
requerido
signing_secret
string
requerido

Returned only here and by rotate-secret. Store it.

Ejemplo:

"whsec_3f1c9a7e5b2d8f0a1c4e6b8d0f2a4c6e8b0d2f4a6c8e0b2d4f6a8c0e2b4d6f8a"