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.

Common fields

string

Represents the version of the event. 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.

Payload

number

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

string

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.

string

The quality of the user’s network.

integer

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

object

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

{
  "version": "1.0.0",
  "type": "waiting-participant.joined",
  "id": "1-w-ptcpt-joined-ed25c43f-e763-4f4d-acbd-51c399a616f1",
  "payload": {
    "room": "knocking",
    "user_name": "bipol",
    "session_id": "ed25c43f-e763-4f4d-acbd-51c399a616f1",
    "joined_at": 1719586645.076,
    "will_eject_at": null,
    "owner": false,
    "permissions": {
      "hasPresence": true,
      "canSend": true,
      "canReceive": { "base": true },
      "canAdmin": false
    },
    "duration": 0
  },
  "event_ts": 1719586645.077
}

​Common fields

​Payload

Common fields

Payload