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.

number

The time in seconds between joined_at and when the event was generated. For this event that is effectively zero.

string

The user session ID, or participant id.

string

The name of the room.

string

The ID of the user. This is the user_id you set on their meeting token. If the participant joined without a meeting token, this field is left out of the payload. SIP and PSTN participants get this from their dial-in or dial-out setup instead.

string | null

The participant’s current name. It starts out as the user_name from their meeting token, or the userName call property if they joined without one, and if the name is changed later with setUserName() the webhook sends the new name. null when no name is set.

unknown

Any custom JSON data set for this participant, from the userData call property at join or from setUserData() later. It does not come from the meeting token. Left out of the payload when no user data is set.

boolean

A flag determining if this user is considered the owner.

string

Only sent for SIP and PSTN participants: one of sip-dial-in, sip-dial-out, pstn-dial-in, pstn-dial-out, or unknown. Regular web participants do not have this field.

number | null

The Unix epoch time in seconds representing when the participant will be ejected. null when no ejection is scheduled, which is the usual case.

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-1719586645077",
  "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