webhook

Transcription available event

Sent on a call.aftercall subscription when the call transcription is ready (event: transcription_available).

transcription_link is deprecated. It is a public CDN URL (v1): anyone with the link can download the transcription JSON. Retrieve the transcription from private_transcription_link. Download that URL with your public API key in the Authorization header, without a Bearer prefix. transcription is the transcript text. ringover_call_path opens the call in the Ringover app.

To certify that the request was sent by Ringover, verify the request signature with your webhook key — see Securing your webhooks under the webhook tag (V1: JWT HS512 in X-Ringover-Webhook-Signature, with the deprecated Authorization header for backward compatibility; V3, on request: Base64 HMAC-SHA256 in X-Ringover-Webhook-Signature-V3).

postWebhooktranscription_available

Payload

eventstring
resourcestring
timestampnumber
attemptinteger

Example payload

{
  "event": "transcription_available",
  "resource": "aftercall",
  "timestamp": 1554823493.762305,
  "data": {
    "call_id": "1234567890987654400",
    "channel_id": "1234567890987654422",
    "transcription_link": "https://cdn.ringover.com/transcriptions/1/babel_transcription_1_1234567890987654400_1234567890987654422.json",
    "private_transcription_link": "https://cdn.ringover.com/v2/public/download/types/transcriptions/1/babel_transcription_1_1234567890987654400_1234567890987654422.json",
    "transcription": "Agent: Hello, how can I help you today?",
    "ringover_call_path": "https://app.ringover.com/call-logs/1234567890987654400"
  }
}

Response

Successful operation

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.