channels

voice

calls

calls-applications

application-webhooks

Event Webhook

Webhook triggered when there is any new event on platform that your application should handle.

postWebhookcalls-event-webhook

Payload

conferenceIdstring

Unique ID of the conference, if the event is related to a conference.

callIdstring

Unique ID of the call, if the event is related to a call.

timestampstring date-time

Date and time for when the event has occurred.

callsConfigurationIdstring

Unique ID of the calls configuration, if the event is related to a calls configuration.

bulkIdstring

Unique ID of the bulk action, if the event is related to a bulk action.

dialogIdstring

Unique ID of the dialog that event is related to.

type'DTMF_CAPTURED' | 'CALL_ESTABLISHED' | 'CALL_PRE_ESTABLISHED' | 'CALL_MEDIA_CHANGED' | 'CALL_FINISHED' | 'CALL_FAILED' | 'CALL_RECEIVED' | 'CALL_STARTED' | 'CALL_RECORDING_STARTED' | 'CALL_RECORDING_FAILED' | 'CALL_RECORDING_READY' | 'CALL_RECORDING_STOPPED' | 'CONFERENCE_RECORDING_STARTED' | 'CONFERENCE_RECORDING_FAILED' | 'CONFERENCE_RECORDING_READY' | 'CONFERENCE_RECORDING_STOPPED' | 'CALL_RINGING' | 'CONFERENCE_CREATED' | 'CONFERENCE_FINISHED' | 'ERROR' | 'PARTICIPANT_MEDIA_CHANGED' | 'PARTICIPANT_JOIN_FAILED' | 'PARTICIPANT_JOINED' | 'PARTICIPANT_JOINING' | 'PARTICIPANT_RECORDING_FAILED' | 'PARTICIPANT_REMOVED' | 'PARTICIPANT_STARTED_TALKING' | 'PARTICIPANT_STOPPED_TALKING' | 'PARTICIPANT_ROLE_CHANGED' | 'PARTICIPANT_ROLE_CHANGE_FAILED' | 'PLAY_FINISHED' | 'CONFERENCE_COMPOSITION_FAILED' | 'CONFERENCE_COMPOSITION_FINISHED' | 'SAY_FINISHED' | 'MACHINE_DETECTION_FINISHED' | 'MACHINE_DETECTION_FAILED' | 'MACHINE_MESSAGE_DETECTION_FINISHED' | 'MACHINE_MESSAGE_DETECTION_FAILED' | 'MEDIA_STREAM_STARTED' | 'MEDIA_STREAM_FAILED' | 'MEDIA_STREAM_FINISHED' | 'APPLICATION_TRANSFER_REQUESTED' | 'APPLICATION_TRANSFER_FAILED' | 'APPLICATION_TRANSFER_FINISHED' | 'DIALOG_CREATED' | 'DIALOG_ESTABLISHED' | 'DIALOG_FAILED' | 'DIALOG_FINISHED' | 'DIALOG_RECORDING_STARTED' | 'DIALOG_RECORDING_FAILED' | 'DIALOG_RECORDING_READY' | 'DIALOG_RECORDING_STOPPED' | 'DIALOG_COMPOSITION_FAILED' | 'DIALOG_COMPOSITION_FINISHED' | 'TRANSCRIPTION' | 'SPEECH_CAPTURED' | 'BULK_CALL_STATUS' | 'CONFERENCE_RECORDING_DELETED' | 'DIALOG_RECORDING_DELETED' | 'CALL_RECORDING_DELETED' | 'CALL_DISCONNECTED' | 'CALL_RECONNECTED' | 'DIALOG_TRANSFER_REQUESTED' | 'DIALOG_TRANSFER_FAILED' | 'DIALOG_TRANSFER_FINISHED'

Type determining content of received event.

Response

Your server returns this code if it accepts the callback.

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.