Webhook map
conversationscallInitiationFailure(conversations.callInitiationFailure)postCallAudio(conversations.postCallAudio)postCallTranscription(conversations.postCallTranscription)
speechToTexttranscriptionCompleted(speechToText.transcriptionCompleted)transcriptionFailed(speechToText.transcriptionFailed)
voicesremovalNotice(voices.removalNotice)removalNoticeWithdrawn(voices.removalNoticeWithdrawn)removed(voices.removed)
HTTP handler setup
app/api/webhook/route.ts
Events
Conversations
Call Initiation Failure
conversations.callInitiationFailure
A phone call could not be started: busy, no answer or unknown.
Payload
data full type
data full type
Response data full type
Response data full type
webhookHooks example
Post Call Audio
conversations.postCallAudio
A conversation ended: the whole conversation as base64 MP3.
Payload
data full type
data full type
Response data full type
Response data full type
webhookHooks example
Post Call Transcription
conversations.postCallTranscription
A conversation ended and its analysis is ready: transcript, metadata and analysis.
Payload
data full type
data full type
Response data full type
Response data full type
webhookHooks example
Speech To Text
Transcription Completed
speechToText.transcriptionCompleted
A transcription started with webhook true finished.
Payload
data full type
data full type
Response data full type
Response data full type
webhookHooks example
Transcription Failed
speechToText.transcriptionFailed
A transcription started with webhook true failed.
Payload
Response data full type
Response data full type
webhookHooks example
Voices
Removal Notice
voices.removalNotice
A shared voice in use is scheduled to be removed.
Payload
Response data full type
Response data full type
webhookHooks example
Removal Notice Withdrawn
voices.removalNoticeWithdrawn
A shared voice is no longer scheduled for removal.
Payload
Response data full type
Response data full type
webhookHooks example
Removed
voices.removed
A shared voice was removed and can no longer be used.
Payload
Response data full type
Response data full type
webhookHooks example