Session events

Session events apply to Meetings, Webinars, and Video SDK implementations. They provide real-time notifications about session activity, participants, media state changes, and in-meeting interactions.

To use session events, you must first establish connections using Universal events. Subscribe to specific session events using the EVENT_SUBSCRIPTION message documented in the universal events reference.

First timestamp from the signaling connection

Sent from the signaling connection

After the signaling connection connects, it sends a message to the app with the first timestamp. Use this timestamp as the start of the session. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 1,
        "timestamp": 1727384349123
    }
}

Active speaker change

Sent from the signaling connection

The signaling connection sends active speaker change events that provide timestamps for when a user is the primary participant speaking (green box around their tile in the session). This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 2,
        "timestamp": 1727384349123,
        "user_id": 22334455,
        "user_name": "John Smith"
    }
}

Participant joined

Sent from the signaling connection

The signaling connection sends participant join events when someone joins the session. This message does not require a response from the app.

{
  "msg_type": 6,
  "event": {
    "event_type": 3,
    "timestamp": 1727384349123,
    "participants": [
      {
        "user_id": xxxxxxxxxx,
        "user_name": "John Smith"
      },
      {
        "user_id": xxxxxxxxxx,
        "user_name": "Alice"
      }
    ]
  }
}

Participant leave

Sent from the signaling connection

The signaling connection sends participant leave events when a user leaves a session, including when it ends. This message does not require a response from the app.

{
  "msg_type": 6,
  "event": {
    "event_type": 4,
    "timestamp": 1727384349123,
    "participants": [
      {
        "user_id": xxxxxxxxxx
      },
      {
        "user_id": xxxxxxxxxx
      }
    ]
  }
}

Sharing started

Sent from the signaling connection

The signaling connection sends sharing started events when a user starts sharing their screen if the app has the DESKSHARE scope. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 5,
        "timestamp": 1727384349123,
        "user_id": 1234234567890,
        "user_name": "John Smith"
    }
}

Sharing stopped

Sent from the signaling connection

The signaling connection sends sharing stopped events when a user stops sharing their screen if the app has the DESKSHARE scope. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 6,
        "timestamp": 1727384349123
    }
}

Participant video on

Sent from the signaling connection

The signaling connection sends a participant video on event when a participant enables their camera and is actively streaming video. Use the user_id in this event to send a video subscription request. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 8,
        "timestamp": 1727384349123,
        "participants": [
            {
                "user_id": 16778240
            },
            {
                "user_id": 33556610
            }
        ]
    }
}

Participant video off

Sent from the signaling connection

The signaling connection sends a participant video off event when a participant turns off their camera. No video stream is being sent from that participant. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 9,
        "timestamp": 1727384349123,
        "participants": [
            {
                "user_id": 16778240
            }
        ]
    }
}

Chat group created

Sent from the signaling connection

The signaling connection sends a chat group created event when a new private chat group is created in the session. Subscribe to this event with event_type: 10. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 10,
        "timestamp": 1727384349123,
        "chat_groups": [
            {
                "chat_group_id": "4105C0A2-76F0-8515-22AC-FD585C25AB82",
                "chat_group_name": "Chat Group",
                "chat_group_type": 0,
                "creator_user_id": 16778240,
                "members": [
                    {
                        "user_id": 16778240,
                        "user_name": "John Smith"
                    }
                ]
            }
        ]
    }
}

Chat group deleted

Sent from the signaling connection

The signaling connection sends a chat group deleted event when one or more private chat groups are deleted from the session. Subscribe to this event with event_type: 11. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 11,
        "timestamp": 1727384349123,
        "chat_groups": [
            {
                "chat_group_id": "4105C0A2-76F0-8515-22AC-FD585C25AB82",
                "chat_group_name": "Chat Group",
                "chat_group_type": 0,
                "creator_user_id": 16778240,
                "members": [
                    {
                        "user_id": 16778240,
                        "user_name": "John Smith"
                    }
                ]
            }
        ]
    }
}

Chat group members added

Sent from the signaling connection

The signaling connection sends a chat group members added event when one or more members are added to a private chat group. Subscribe to this event with event_type: 12. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 12,
        "timestamp": 1727384349123,
        "members_update_list": [
            {
                "chat_group_id": "4FAFFE72-FF2E-4E07-3773-248326841CBE",
                "members": [
                    {
                        "user_id": 16778240,
                        "user_name": "John Smith"
                    }
                ]
            }
        ]
    }
}

Chat group members removed

Sent from the signaling connection

The signaling connection sends a chat group members removed event when one or more members are removed from a private chat group. Subscribe to this event with event_type: 13. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 13,
        "timestamp": 1727384349123,
        "members_update_list": [
            {
                "chat_group_id": "4FAFFE72-FF2E-4E07-3773-248326841CBE",
                "members": [
                    {
                        "user_id": 16778240,
                        "user_name": "John Smith"
                    }
                ]
            }
        ]
    }
}

Chat group member status updated

Sent from the signaling connection

The signaling connection sends a chat group member status updated event when the in-meeting status of a private chat group member changes. Subscribe to this event with event_type: 14. This message does not require a response from the app.

{
    "msg_type": 6,
    "event": {
        "event_type": 14,
        "timestamp": 1727384349123,
        "member_status_update_list": [
            {
                "chat_group_id": "4FAFFE72-FF2E-4E07-3773-248326841CBE",
                "user_id": 16778240,
                "user_name": "John Smith",
                "member_status": 1
            }
        ]
    }
}