ScreenMeet sends events as denormalized JSON objects. Please note that not all events contain all attributes, so the data should generally be considered sparse. Not all events may be covered in this document.<h2>Event Fields</h2><table style="min-width: 75px;"><tbody><tr><td colspan="1" rowspan="1">Field</td><td colspan="1" rowspan="1">Type</td><td colspan="1" rowspan="1">Description</td></tr><tr><td colspan="1" rowspan="1">type</td><td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">The event name, please see Event Types for a description of the events.</td></tr><tr><td colspan="1" rowspan="1">ts</td><td colspan="1" rowspan="1">Date ISO String</td><td colspan="1" rowspan="1">A timestamp in ISO format (eg, "2021-08-09T16:45:57.000Z")</td></tr><tr><td colspan="1" rowspan="1">message</td><td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">A human-friendly message describing the event.</td></tr><tr><td colspan="1" rowspan="1">id</td><td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">The unique 6 or 12 character base62 session id.</td></tr><tr><td colspan="1" rowspan="1">label</td><td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">A subject / description for this session.</td></tr><tr><td colspan="1" rowspan="1">userDescription</td><td colspan="1" rowspan="1">string</td><td colspan="1" rowspan="1">A description of the ScreenMeet user (aka display name) - will be shown in support and cobrowse product when the end-user is being asked whether they would like to share their screen with this person.</td></tr><tr><td colspan="1" rowspan="1">status</td><td colspan="1" rowspan="1">string enum</td><td colspan="1" rowspan="1">Possible values for that field are "scheduled" (scheduled for future), "new" (ready to join), "active" (at least one participant has joined), and "closed" (session is closed/ended).</td></tr><tr><td colspan="1" rowspan="1">user</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">Information about the agent who created this session</td></tr><tr><td colspan="1" rowspan="1">organization</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">Information about the agent's organization which created this session.</td></tr><tr><td colspan="1" rowspan="1">settings</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">A set of name-value pairs of settings that were used to create this session (mapped from AgentPrefs).</td></tr><tr><td colspan="1" rowspan="1">createdByAgentSession</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">A descriptor of the ScreenMeet user's authenticated session that was used to create this session.</td></tr><tr><td colspan="1" rowspan="1">crmSyncTarget</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">A description of the related entity in an external system if the session was created via an integration.</td></tr><tr><td colspan="1" rowspan="1">device</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">A collection of name-value pairs describing the user's device, such as their browser for cobrowse sessions, or native app environment for remote support sessions.</td></tr><tr><td colspan="1" rowspan="1">stats</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">The stats object contains various statistics and metadata about the session.</td></tr><tr><td colspan="1" rowspan="1">seconds</td><td colspan="1" rowspan="1">int</td><td colspan="1" rowspan="1">How many seconds into the session did this event occur</td></tr><tr><td colspan="1" rowspan="1">servers</td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">A description of which ScreenMeet servers were used to facilitate the session.</td></tr><tr><td colspan="1" rowspan="1">storedFile </td><td colspan="1" rowspan="1">object</td><td colspan="1" rowspan="1">Metadata about file that was uploaded to storage. Only applies to file-uploaded-to-storage event.</td></tr></tbody></table><h2>Event Types</h2><table style="min-width: 75px;"><tbody><tr><td colspan="1" rowspan="1">Event Type</td><td colspan="1" rowspan="1">Products</td><td colspan="1" rowspan="1">Description</td></tr><tr><td colspan="1" rowspan="1">session-created</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">Session was created by a ScreenMeet agent</td></tr><tr><td colspan="1" rowspan="1">session-closed</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">Session has ended</td></tr><tr><td colspan="1" rowspan="1">video-stream-started</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">User started streaming their desktop</td></tr><tr><td colspan="1" rowspan="1">chat</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">Chat message sent in-session</td></tr><tr><td colspan="1" rowspan="1">user-connected</td><td colspan="1" rowspan="1">support, cobrowse</td><td colspan="1" rowspan="1">End-user has connected to the session</td></tr><tr><td colspan="1" rowspan="1">user-disconnected</td><td colspan="1" rowspan="1">support, cobrowse</td><td colspan="1" rowspan="1">End-user had disconnected from the session</td></tr><tr><td colspan="1" rowspan="1">session-ending</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Session shut-down has been initiated and it will be closed shortly</td></tr><tr><td colspan="1" rowspan="1">agent-joined</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">A ScreenMeet agent has joined the session</td></tr><tr><td colspan="1" rowspan="1">client-event</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">A log event was sent by the end-user's client</td></tr><tr><td colspan="1" rowspan="1">clipboard-link-on</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Clipboard linking was activated by ScreenMeet Agent</td></tr><tr><td colspan="1" rowspan="1">agent-left</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Agent has disconnected from the session</td></tr><tr><td colspan="1" rowspan="1">remote-control-requested</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Agent has requested remote control of end-user's device</td></tr><tr><td colspan="1" rowspan="1">remote-control-granted</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">End-user has granted remote control to the agent</td></tr><tr><td colspan="1" rowspan="1">remote-control-stopped</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Remote control of end-user's device has stopped</td></tr><tr><td colspan="1" rowspan="1">uac-requested</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Admin permission requested on end-user's device</td></tr><tr><td colspan="1" rowspan="1">uac-permission-granted</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Admin permission granted on end-user's device</td></tr><tr><td colspan="1" rowspan="1">uac-permission-denied</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">Admin permission denied on end-user's device</td></tr><tr><td colspan="1" rowspan="1">remote-execute</td><td colspan="1" rowspan="1">support</td><td colspan="1" rowspan="1">A remote macro / command was executed on user's device</td></tr><tr><td colspan="1" rowspan="1">file-uploaded</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">A file was uploaded to the server</td></tr><tr><td colspan="1" rowspan="1">file-uploaded-to-storage</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">A file was uploaded to permanent storage</td></tr><tr><td colspan="1" rowspan="1">url-navigate</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">User has navigated to this URL</td></tr><tr><td colspan="1" rowspan="1">session-rating</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">Agent submitted a session rating after the session</td></tr><tr><td colspan="1" rowspan="1">session-server-selected</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">A server was selected to host the session</td></tr><tr><td colspan="1" rowspan="1">microphone-access-requested</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Permission to acquire audio stream from a user's microphone was requested</td></tr><tr><td colspan="1" rowspan="1">camera-access-requested</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Permission to acquire audio stream from a user's camera was requested</td></tr><tr><td colspan="1" rowspan="1">camera-access-succeeded</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Video stream from a user's camera was acquired</td></tr><tr><td colspan="1" rowspan="1">microphone-access-succeeded</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Audio stream from a user's microphone was acquired</td></tr><tr><td colspan="1" rowspan="1">entered-lobby</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user has entered the meeting lobby</td></tr><tr><td colspan="1" rowspan="1">user-joined</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user has joined the meeting</td></tr><tr><td colspan="1" rowspan="1">user-left</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user has departed the meeting</td></tr><tr><td colspan="1" rowspan="1">audio-muted</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user muted their audio stream</td></tr><tr><td colspan="1" rowspan="1">audio-resumed</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user unmuted their audio stream</td></tr><tr><td colspan="1" rowspan="1">desktop-access-requested</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Permission to acquire video stream from a user's desktop was requested</td></tr><tr><td colspan="1" rowspan="1">desktop-access-succeeded</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Video stream from a user's desktop was acquired</td></tr><tr><td colspan="1" rowspan="1">microphone-access-error</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">An error occurred while acquiring the user's audio stream</td></tr><tr><td colspan="1" rowspan="1">camera-access-error</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">An error occurred while acquiring the user's camera video stream</td></tr><tr><td colspan="1" rowspan="1">session-feedback</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">A ScreenMeet agent submitted feedback on the session quality after it ended</td></tr><tr><td colspan="1" rowspan="1">record-toggled</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">Recording was toggled for a live session</td></tr><tr><td colspan="1" rowspan="1">desktop-access-error</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">An error occurred while acquiring the user's desktop video stream</td></tr><tr><td colspan="1" rowspan="1">room-entry-requested</td><td colspan="1" rowspan="1">live</td><td colspan="1" rowspan="1">A user requested entry into the room</td></tr><tr><td colspan="1" rowspan="1">file-download</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">A stored recording or file was downloaded via the ScreenMeet console</td></tr><tr><td colspan="1" rowspan="1">session-data-expired</td><td colspan="1" rowspan="1">all</td><td colspan="1" rowspan="1">ScreenMeet's data retention policy has purged data for this session</td></tr><tr><td colspan="1" rowspan="1">agent-connected</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">A ScreenMeet agent connected to the session</td></tr><tr><td colspan="1" rowspan="1">agent-disconnected</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">A ScreenMeet agent disconnected to the session</td></tr><tr><td colspan="1" rowspan="1">page-focus</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">The user's browser has focused on a page that is being cobrowsed</td></tr><tr><td colspan="1" rowspan="1">cb-dialog-pin-entered</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">The user has entered a PIN into the cobrowse modal dialog</td></tr><tr><td colspan="1" rowspan="1">remote-control-permission-request</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">Remote control permission was requested from the user</td></tr><tr><td colspan="1" rowspan="1">remote-control-permission-granted</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">Remote control permission was granted by the user</td></tr><tr><td colspan="1" rowspan="1">remote-control-permission-denied</td><td colspan="1" rowspan="1">cobrowse</td><td colspan="1" rowspan="1">Remote control permission was denied by the user</td></tr></tbody></table><h2>Sample Event Objects</h2><h3>Cobrowse Event</h3><pre><code class="language-json">{
 "id": "kpkvgPbBYkxC",
 "userDescription": "Joe",
 "label": "test cb",
 "status": "closed",
 "settings": {
 "audio": true,
 "knock": false,
 "recording": true,
 "startwithrc": false,
 "startwithadmin": false
 },
 "stats": {
 "agents": [
 {
 "id": 9916,
 "externalId": "0054T000000jyEhQAI",
 "name": "Joe Smith",
 "isActive": true,
 "turn": "turn-11601.screenmeet.com",
 "ua": {
 "family": "Chrome",
 "major": "92",
 "minor": "0",
 "patch": "4515",
 "device": {
 "family": "Other",
 "major": "0",
 "minor": "0",
 "patch": "0"
 },
 "os": {
 "family": "Mac OS X",
 "major": "10",
 "minor": "15",
 "patch": "7"
 }
 },
 "cid": "d2bf6dec-3ece-4af1-b002-d37df5be649c"
 }
 ],
 "streamType": "cobrowse",
 "chat-message-count": 0,
 "max-concurrent-viewers": 0,
 "time-ended": "2021-08-17T20:38:00.313Z",
 "duration": 22,
 "duration-connected": 16,
 "termination-reason": "closed by agent",
 "metrics": {
 "dom_size": {
 "total": 1,
 "mdn": 85951,
 "avg": 85951,
 "std": 0,
 "min": 85951,
 "max": 85951
 },
 "loading_time_end_user_ms": {
 "total": 1,
 "mdn": 2235,
 "avg": 2235,
 "std": 0,
 "min": 2235,
 "max": 2235
 },
 "from_pin_to_agent_connect_ms": {
 "total": 1,
 "mdn": 5497,
 "avg": 5497,
 "std": 0,
 "min": 5497,
 "max": 5497
 }
 }
 },
 "metaData": {},
 "servers": {
 "cobrowse": {
 "id": 12327,
 "endpoint": "https://cb-12327.screenmeet.com:443",
 "use_proxy": true,
 "proxy_endpoint": "https://rt-proxy.screenmeet.com",
 "proxy_dns_prefix": "cb-12327",
 "serverInstanceId": "i-02ce1f3676c3bfd10"
 },
 "recorder": {
 "id": 11590
 }
 },
 "createdByAgentSession": {
 "sid": 2435146,
 "roles": {
 "agent": true,
 "group_admin": true
 },
 "features": null,
 "provider": "sfdc",
 "remoteIp": "98.118.28.54",
 "clientApp": null,
 "expiresAt": "2021-08-24T20:24:43.000Z",
 "startedAt": "2021-08-17T20:24:43.000Z",
 "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
 "providerExternalId": "0054T000000jyEhQAI"
 },
 "pin": 218560,
 "organization": {
 "id": 265,
 "provider": "sfdc",
 "name": "ScreenMeet Developer Org",
 "instanceUrl": "https://screenmeetdev-dev-ed.my.salesforce.com",
 "externalId": "00D4T000000FwP4UAK",
 "CustomerId": 265
 },
 "user": {
 "id": 9916,
 "email": "joe@example.com",
 "name": "Joe Smith",
 "externalId": "0054T000000jyEhQAI",
 "createdAt": "2019-09-23T23:16:18.000Z"
 },
 "crmSyncTarget": {},
 "ts": "2021-08-17T20:37:40.019Z",
 "type": "url-navigate",
 "message": "End-user navigated to https://cbdemo.screenmeet.com/",
 "device": {
 "browser_name": "Chrome",
 "browser_version": "92.0.4515.131",
 "browser_major": "92",
 "engine_name": "Blink",
 "engine_version": "92.0.4515.131",
 "os_name": "Mac OS",
 "os_version": "10.15.7"
 },
 "seconds": 1
 }</code></pre><h3>File Uploaded to Storage</h3><pre><code class="language-json"> {
 "organization": {
 "id": 265,
 "provider": "sfdc",
 "name": "ScreenMeet Developer Org",
 "instanceUrl": "https://screenmeetdev-dev-ed.my.salesforce.com",
 "externalId": "00D4T000000FwP4UAK",
 "CustomerId": 265
 },
 "user": {
 "id": 9916,
 "email": "joe@example.com",
 "name": "Joe Smith",
 "externalId": "0054T000000jyEhQAI",
 "createdAt": "2019-09-23T23:16:18.000Z"
 },
 "ts": "2021-08-17T20:38:03.429Z",
 "storedFile": {
 "SupportSessionId": "kpkvgPbBYkxC",
 "OrganizationId": 265,
 "ExternalUserId": 9916,
 "size": 574295,
 "type": "recording",
 "name": "kpkvgPbBYkxC-2021-08-17.20.37.webm",
 "uploader": "ScreenMeet Session Recorder",
 "externalObjectId": "v3/2021/8/17/kpkvgPbBYkxC/kpkvgPbBYkxC-2021-08-17.20.37.webm",
 "provider": "screenmeet",
 "location": "v3/2021/8/17/kpkvgPbBYkxC/kpkvgPbBYkxC-2021-08-17.20.37.webm",
 "downloadable": true,
 "linkable": false,
 "usesRetentionPolicy": true
 },
 "type": "file-uploaded-to-storage",
 "message": "File kpkvgPbBYkxC-2021-08-17.20.37.webm from session kpkvgPbBYkxC uploaded to [screenmeet]: v3/2021/8/17/kpkvgPbBYkxC/kpkvgPbBYkxC-2021-08-17.20.37.webm",
 "crmSyncTarget": {}
 }</code></pre>

Webhook Data Dictionary

Getting Application from ServiceNow Store

Using your Azure Blob for ScreenMeet File Storage

Minimal Cobrowse Script

Frequently Asked Questions

Timeout Settings

July

Remote Control

IP Access Control Feature

Live Release Notes Q2 2024

Video Chat Integration

Cobrowse Settings

CoBrowse Release Notes Q2 23

Connecting to Mac devices

Connecting to a Device Using Beam

Windows Tools

Starting a session

CoBrowse Release Notes Q1 22

Remote Support Release Notes Q4 24

Clipboard

Release Summer 21 (1.14)

Virtual Agent Integration w/ ScreenMeet

Android SDK Quickstart

Security

Remote Support Release Notes Q3 23

Replay Settings

Custom Copy

CoBrowse Deployments

AI Summary History

Integration Signing Key

Microsoft D365 Release Notes Q4 2022

Replay Release Notes Q2 24

October

Live Settings

ScreenMeet Console Customers

Hosting a Desktop Session

Remote Support Release Notes Q2 23

Creating a Replay Recording

AI Assist Overview

Included Reports and how to add them into Dashboards

Custom Domain

Networking Configuration

AI Summarization

Remote Support

Overview

Remote Support Settings

CoBrowse Release Notes Q2 24

Sign in to console.screenmeet.com

Multiple Domain and Subdomain support

February

File Transfer Settings

Exporting ScreenMeet + Salesforce data to third party visualization tools

Beam Release Notes Q1 24

Regional Geo-Fencing

Custom Branding

AI Assist

Configure API service

Beam Release Notes Q3 23

Joining & Completing a Live Plus session

Egress IP Addresses

Custom URL

Starting a Session from within Salesforce

Settings and Policies

Requirements

How To Install ScreenMeet in Your Genesys Instance

Localization

Configuring Environment Variables

Reviewing a Session

August

Remote Support Release Notes Q1 23

Live Release Notes Q2 22

Release Summer 2020 (1.9)

Device Requirements

System Information

Create Multiple Sessions

ServiceNow Release Notes Q4 24

403 Forbidden while making API request

Manage Beam Group Permission Set

ScreenMeet Platform Release Notes Q3 23

Remote Support Release Notes - Q1 22

Screen Annotation

Creating a Session

Custom Background

Remote Support Release Notes Q2 24

AI Summary Studio

Instructions to Person at End Point Device

Beam Client: Installation, Deployment, and Configuration Guide

Beam Groups: Setup, Settings, and Access Management

Component settings

Customer initiated sessions with a chatbot

ScreenMeet 2024 Release Notes

Package Installation Error - Case-Case Layout: feedLayout is not supported for this layout

Developer Notes (3.0.11)

Starting a Session from Dynamics

ScreenMeet Platform Release Notes Q1 23

Remote Support Release Notes Q2 22