Waiting Participant Joined

A waiting participant joined event is sent when a knocker (see blog post) begins to knock. Once a waiting participant is allowed to join the call, a participant.joined event is sent. Otherwise, if a participant leaves the knocking state, a waiting-participant.left is sent.

Webhook Events

There are five common fields all events share:

string

Represents the version of the event. This uses semantic versioning to inform a consumer if the payload has introduced any breaking changes.

string

Represents the type of the event described in the payload.

string

An identifier representing this specific event.

object

An object representing the event, whose fields are described below.

number

Documenting when the webhook itself was sent. This timestamp is different than the time of the event the webhook describes. For example, a recording.started event will contain a start_ts timestamp of when the actual recording started, and a slightly later event_ts timestamp indicating when the webhook event was sent.

Payload

string

The semantic version of the current message.

string

The type of event that is being provided.

Options: "waiting-participant.joined"
integer

The Unix epoch time in seconds representing when the event was generated.

object

The payload of the object, describing the given event.

integer

The Unix epoch time in seconds representing when the waiting participant joined.

The user session ID, or participant id.

string

The name of the room.

string

The ID of the user, set by the meeting token.

string

The name of the user, set by the meeting token.

boolean

A flag determining if this user is considered the owner.

The Unix epoch time in seconds representing when the participant will be ejected.

The permissions object, that describes what the participant is permitted to do during this call.

Determines whether the participant is "present" or "hidden"

array

Array of strings identifying which types of media the participant can send or a boolean to grant/revoke permissions for all media types.

Array of strings identifying which types of admin tasks the participant can do or a boolean to grant/revoke permissions for all types.

;