Skip to main content

Events

Here you can find the list of events are sent to Webhook and SQS.

NameDescription
call.acceptedThis event is sent when a user accepts a notification to join a call.
call.blocked_userThis event is sent to call participants to notify when a user is blocked on a call, clients can use this event to show a notification. If the user is the current user, the client should leave the call screen as well
call.closed_captionThis event is sent when closed captions are being sent in a call, clients should use this to show the closed captions in the call screen
call.createdThis event is sent when a call is created. Clients receiving this event should check if the ringing field is set to true and if so, show the call screen
call.deletedThis event is sent when a call is deleted. Clients receiving this event should leave the call screen
call.endedThis event is sent when a call is mark as ended for all its participants. Clients receiving this event should leave the call screen
call.hls_broadcasting_failedThis event is sent when HLS broadcasting has failed
call.hls_broadcasting_startedThis event is sent when HLS broadcasting has started
call.hls_broadcasting_stoppedThis event is sent when HLS broadcasting has stopped
call.live_startedThis event is sent when a call is started. Clients receiving this event should start the call.
call.member_addedThis event is sent when one or more members are added to a call
call.member_removedThis event is sent when one or more members are removed from a call
call.member_updatedThis event is sent when one or more members are updated
call.member_updated_permissionThis event is sent when one or more members get its role updated
call.missedThis event is sent to call members who did not accept/reject/join the call to notify they missed the call
call.notificationThis event is sent to all call members to notify they are getting called
call.permission_requestThis event is sent when a user requests access to a feature on a call, clients receiving this event should display a permission request to the user
call.permissions_updatedThis event is sent to notify about permission changes for a user, clients receiving this event should update their UI accordingly
call.reaction_newThis event is sent when a reaction is sent in a call, clients should use this to show the reaction in the call screen
call.recording_failedThis event is sent when call recording has failed
call.recording_readyThis event is sent when call recording is ready
call.recording_startedThis event is sent when call recording has started
call.recording_stoppedThis event is sent when call recording has stopped
call.rejectedThis event is sent when a user rejects a notification to join a call.
call.ringThis event is sent to all call members to notify they are getting called
call.rtmp_broadcast_failedThis event is sent when a call RTMP broadcast has failed
call.rtmp_broadcast_startedThis event is sent when RTMP broadcast has started
call.rtmp_broadcast_stoppedThis event is sent when RTMP broadcast has stopped
call.session_endedThis event is sent when a call session ends
call.session_participant_count_updatedThis event is sent when the participant counts in a call session are updated
call.session_participant_joinedThis event is sent when a participant joins a call session
call.session_participant_leftThis event is sent when a participant leaves a call session
call.session_startedThis event is sent when a call session starts
call.transcription_failedThis event is sent when call transcription has failed
call.transcription_readyThis event is sent when call transcription is ready
call.transcription_startedThis event is sent when call transcription has started
call.transcription_stoppedThis event is sent when call transcription has stopped
call.unblocked_userThis event is sent when a user is unblocked on a call, this can be useful to notify the user that they can now join the call again
call.updatedThis event is sent when a call is updated, clients should use this update the local state of the call. This event also contains the capabilities by role for the call, clients should update the own_capability for the current.
call.user_mutedThis event is sent when a call member is muted
customA custom event, this event is used to send custom events to other participants in the call.

BlockedUserEvent

NameTypeDescriptionConstraints
blocked_by_userUserResponseThe user that blocked the user, null if the user was blocked by server-side-
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.blocked_user" in this caseRequired
userUserResponseThe user that was blockedRequired

CallAcceptedEvent

NameTypeDescriptionConstraints
callCallResponse-Required
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.accepted" in this caseRequired
userUserResponseThe user who accepted the callRequired

CallCreatedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]the members added to this callRequired
typestringThe type of event: "call.created" in this caseRequired

CallDeletedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.deleted" in this caseRequired

CallEndedEvent

NameTypeDescriptionConstraints
callCallResponse-Required
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.ended" in this caseRequired
userUserResponseThe user who ended the call, null if the call was ended by the server-

CallHLSBroadcastingFailedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.hls_broadcasting_failed" in this caseRequired

CallHLSBroadcastingStartedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
hls_playlist_urlstring-Required
typestringThe type of event: "call.hls_broadcasting_started" in this caseRequired

CallHLSBroadcastingStoppedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.hls_broadcasting_stopped" in this caseRequired

CallLiveStartedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.live_started" in this caseRequired

CallMemberAddedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]the members added to this callRequired
typestringThe type of event: "call.member_added" in this caseRequired

CallMemberRemovedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersstring[]the list of member IDs removed from the callRequired
typestringThe type of event: "call.member_removed" in this caseRequired

CallMemberUpdatedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]The list of members that were updatedRequired
typestringThe type of event: "call.member_updated" in this caseRequired

CallMemberUpdatedPermissionEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
capabilities_by_roleobjectThe capabilities by role for this callRequired
created_atnumber-Required
membersMemberResponse[]The list of members that were updatedRequired
typestringThe type of event: "call.member_added" in this caseRequired

CallMissedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]List of members who missed the callRequired
notify_userboolean-Required
session_idstringCall session IDRequired
typestringThe type of event: "call.notification" in this caseRequired
userUserResponseThe caller from whom the call was missedRequired

CallNotificationEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]Call membersRequired
session_idstringCall session IDRequired
typestringThe type of event: "call.notification" in this caseRequired
userUserResponseThe user that sent the call notificationRequired

CallReactionEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
reactionReactionResponsethe reaction object sent by the user on the callRequired
typestringThe type of event: "call.reaction_new" in this caseRequired

CallRecordingFailedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.recording_failed" in this caseRequired

CallRecordingReadyEvent

NameTypeDescriptionConstraints
call_cidstring-Required
call_recordingCallRecordingThe call recording objectRequired
created_atnumber-Required
typestringThe type of event: "call.recording_ready" in this caseRequired

CallRecordingStartedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.recording_started" in this caseRequired

CallRecordingStoppedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.recording_stopped" in this caseRequired

CallRejectedEvent

NameTypeDescriptionConstraints
callCallResponse-Required
call_cidstring-Required
created_atnumber-Required
reasonstring--
typestringThe type of event: "call.rejected" in this caseRequired
userUserResponseThe user who rejected the callRequired

CallRingEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
membersMemberResponse[]Call membersRequired
session_idstringCall session IDRequired
typestringThe type of event: "call.notification" in this caseRequired
userUserResponseThe user that sent the call notificationRequired
videoboolean-Required

CallRtmpBroadcastFailedEvent

NameTypeDescriptionConstraints
call_cidstringThe unique identifier for a call (<type>:<id>)Required
created_atnumberDate/time of creationRequired
namestringName of the given RTMP broadcastRequired
typestringThe type of event: "call.rtmp_broadcast_failed" in this caseRequired

CallRtmpBroadcastStartedEvent

NameTypeDescriptionConstraints
call_cidstringThe unique identifier for a call (<type>:<id>)Required
created_atnumberDate/time of creationRequired
namestringName of the given RTMP broadcastRequired
typestringThe type of event: "call.rtmp_broadcast_started" in this caseRequired

CallRtmpBroadcastStoppedEvent

NameTypeDescriptionConstraints
call_cidstringThe unique identifier for a call (<type>:<id>)Required
created_atnumberDate/time of creationRequired
namestringName of the given RTMP broadcastRequired
typestringThe type of event: "call.rtmp_broadcast_stopped" in this caseRequired

CallSessionEndedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
session_idstringCall session IDRequired
typestringThe type of event: "call.session_ended" in this caseRequired

CallSessionParticipantCountsUpdatedEvent

NameTypeDescriptionConstraints
anonymous_participant_countinteger-Required
call_cidstring-Required
created_atnumber-Required
participants_count_by_roleobject-Required
session_idstringCall session IDRequired
typestringThe type of event: "call.session_participant_count_updated" in this caseRequired

CallSessionParticipantJoinedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
participantCallParticipantResponseThe participant that joined the sessionRequired
session_idstringCall session IDRequired
typestringThe type of event: "call.session_participant_joined" in this caseRequired

CallSessionParticipantLeftEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
participantCallParticipantResponseThe participant that left the sessionRequired
session_idstringCall session IDRequired
typestringThe type of event: "call.session_participant_left" in this caseRequired

CallSessionStartedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
created_atnumber-Required
session_idstringCall session IDRequired
typestringThe type of event: "call.session_started" in this caseRequired

CallTranscriptionFailedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.transcription_failed" in this caseRequired

CallTranscriptionReadyEvent

NameTypeDescriptionConstraints
call_cidstring-Required
call_transcriptionCallTranscriptionThe call transcription objectRequired
created_atnumber-Required
typestringThe type of event: "call.transcription_ready" in this caseRequired

CallTranscriptionStartedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.transcription_started" in this caseRequired

CallTranscriptionStoppedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.transcription_stopped" in this caseRequired

CallUpdatedEvent

NameTypeDescriptionConstraints
callCallResponseCall objectRequired
call_cidstring-Required
capabilities_by_roleobjectThe capabilities by role for this callRequired
created_atnumber-Required
typestringThe type of event: "call.ended" in this caseRequired

CallUserMutedEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
from_user_idstring-Required
muted_user_idsstring[]-Required
typestringThe type of event: "call.user_muted" in this caseRequired

ClosedCaptionEvent

NameTypeDescriptionConstraints
call_cidstring-Required
closed_captionCallClosedCaptionThe closed caption objectRequired
created_atnumber-Required
typestringThe type of event: "call.closed_caption" in this caseRequired

CustomVideoEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
customobjectCustom data for this objectRequired
typestringThe type of event, "custom" in this caseRequired
userUserResponse-Required

PermissionRequestEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
permissionsstring[]The list of permissions requested by the userRequired
typestringThe type of event: "call.permission_request" in this caseRequired
userUserResponseThe user who sent the permission requestRequired

UnblockedUserEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
typestringThe type of event: "call.unblocked_user" in this caseRequired
userUserResponseThe user that was unblockedRequired

UpdatedCallPermissionsEvent

NameTypeDescriptionConstraints
call_cidstring-Required
created_atnumber-Required
own_capabilitiesOwnCapability[]The capabilities of the current userRequired
typestringThe type of event: "call.permissions_updated" in this caseRequired
userUserResponseThe user who received the new permissionsRequired

UserResponse

NameTypeDescriptionConstraints
bannedbooleanWhether a user is banned or notRequired
blocked_user_idsstring[]-Required
created_atnumberDate/time of creationRequired
customobjectCustom data for this objectRequired
deactivated_atnumberDate of deactivation-
deleted_atnumberDate/time of deletion-
idstringUnique user identifierRequired
imagestring--
languagestringPreferred language of a userRequired
last_activenumberDate of last activity-
namestringOptional name of user-
onlinebooleanWhether a user online or notRequired
revoke_tokens_issued_beforenumberRevocation date for tokens-
rolestringDetermines the set of user permissionsRequired
teamsstring[]List of teams user is a part ofRequired
updated_atnumberDate/time of the last updateRequired

CallResponse

NameTypeDescriptionConstraints
backstageboolean-Required
blocked_user_idsstring[]-Required
cidstringThe unique identifier for a call (<type>:<id>)Required
created_atnumberDate/time of creationRequired
created_byUserResponseThe user that created the callRequired
current_session_idstring-Required
customobjectCustom data for this objectRequired
egressEgressResponse-Required
ended_atnumberDate/time when the call ended-
idstringCall IDRequired
ingressCallIngressResponse-Required
join_ahead_time_secondsinteger--
recordingboolean-Required
sessionCallSessionResponse--
settingsCallSettingsResponse-Required
starts_atnumberDate/time when the call will start-
teamstring--
thumbnailsThumbnailResponse--
transcribingboolean-Required
typestringThe type of callRequired
updated_atnumberDate/time of the last updateRequired

MemberResponse

NameTypeDescriptionConstraints
created_atnumberDate/time of creationRequired
customobjectCustom member response dataRequired
deleted_atnumberDate/time of deletion-
rolestring--
updated_atnumberDate/time of the last updateRequired
userUserResponse-Required
user_idstring-Required

ReactionResponse

NameTypeDescriptionConstraints
created_atnumberDate/time of creationRequired
customobjectCustom data for this objectRequired
message_idstringMessage IDRequired
scoreintegerScore of the reactionRequired
typestringType of reactionRequired
updated_atnumberDate/time of the last updateRequired
userUserResponseUserRequired
user_idstringUser IDRequired

CallRecording

NameTypeDescriptionConstraints
end_timenumber-Required
filenamestring-Required
start_timenumber-Required
urlstring-Required

CallParticipantResponse

NameTypeDescriptionConstraints
joined_atnumber-Required
rolestring-Required
userUserResponse-Required
user_session_idstring-Required

CallTranscription

NameTypeDescriptionConstraints
end_timenumber-Required
filenamestring-Required
start_timenumber-Required
urlstring-Required

CallClosedCaption

NameTypeDescriptionConstraints
end_timenumber-Required
speaker_idstring-Required
start_timenumber-Required
textstring-Required

EgressResponse

NameTypeDescriptionConstraints
broadcastingboolean-Required
hlsEgressHLSResponse--
rtmpsEgressRTMPResponse[]-Required

CallIngressResponse

NameTypeDescriptionConstraints
rtmpRTMPIngress-Required

CallSessionResponse

NameTypeDescriptionConstraints
accepted_byobject-Required
anonymous_participant_countinteger-Required
ended_atnumber--
idstring-Required
live_ended_atnumber--
live_started_atnumber--
missed_byobject-Required
participantsCallParticipantResponse[]-Required
participants_count_by_roleobject-Required
rejected_byobject-Required
started_atnumber--
timer_ends_atnumber--

CallSettingsResponse

NameTypeDescriptionConstraints
audioAudioSettingsResponse-Required
backstageBackstageSettingsResponse-Required
broadcastingBroadcastSettingsResponse-Required
geofencingGeofenceSettingsResponse-Required
limitsLimitsSettingsResponse-Required
recordingRecordSettingsResponse-Required
ringRingSettingsResponse-Required
screensharingScreensharingSettingsResponse-Required
thumbnailsThumbnailsSettingsResponse-Required
transcriptionTranscriptionSettingsResponse-Required
videoVideoSettingsResponse-Required

ThumbnailResponse

NameTypeDescriptionConstraints
image_urlstring-Required

EgressHLSResponse

NameTypeDescriptionConstraints
playlist_urlstring-Required

EgressRTMPResponse

NameTypeDescriptionConstraints
namestring-Required
started_atnumber-Required
stream_keystring--
stream_urlstring--

RTMPIngress

NameTypeDescriptionConstraints
addressstring-Required

AudioSettingsResponse

NameTypeDescriptionConstraints
access_request_enabledboolean-Required
default_devicestring (speaker, earpiece)-Required
mic_default_onboolean-Required
noise_cancellationNoiseCancellationSettings--
opus_dtx_enabledboolean-Required
redundant_coding_enabledboolean-Required
speaker_default_onboolean-Required

BackstageSettingsResponse

NameTypeDescriptionConstraints
enabledboolean-Required
join_ahead_time_secondsinteger--

BroadcastSettingsResponse

NameTypeDescriptionConstraints
enabledboolean-Required
hlsHLSSettingsResponse-Required
rtmpRTMPSettingsResponse-Required

GeofenceSettingsResponse

NameTypeDescriptionConstraints
namesstring[]-Required

LimitsSettingsResponse

NameTypeDescriptionConstraints
max_duration_secondsinteger--
max_participantsinteger--

RecordSettingsResponse

NameTypeDescriptionConstraints
audio_onlyboolean-Required
modestring-Required
qualitystring-Required

RingSettingsResponse

NameTypeDescriptionConstraints
auto_cancel_timeout_msinteger-Required
incoming_call_timeout_msinteger-Required
missed_call_timeout_msinteger-Required

ScreensharingSettingsResponse

NameTypeDescriptionConstraints
access_request_enabledboolean-Required
enabledboolean-Required
target_resolutionTargetResolution--

ThumbnailsSettingsResponse

NameTypeDescriptionConstraints
enabledboolean-Required

TranscriptionSettingsResponse

NameTypeDescriptionConstraints
closed_caption_modestring-Required
languagesstring[]-Required, Maximum: 2
modestring (available, disabled, auto-on)-Required

VideoSettingsResponse

NameTypeDescriptionConstraints
access_request_enabledboolean-Required
camera_default_onboolean-Required
camera_facingstring (front, back, external)-Required
enabledboolean-Required
target_resolutionTargetResolution-Required

NoiseCancellationSettings

NameTypeDescriptionConstraints
modestring (available, disabled, auto-on)-Required

HLSSettingsResponse

NameTypeDescriptionConstraints
auto_onboolean-Required
enabledboolean-Required
quality_tracksstring[]-Required

RTMPSettingsResponse

NameTypeDescriptionConstraints
enabledboolean-Required
qualitystring-Required

TargetResolution

NameTypeDescriptionConstraints
bitrateinteger-Maximum: 6000000
heightinteger-Required, Minimum: 240, Maximum: 3840
widthinteger-Required, Minimum: 240, Maximum: 3840

Did you find this page helpful?