Webhooks

Webhook Data Dictionary

Updated Sep 2, 20266 min read

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.

Event Fields

Field	Type	Description
type	string	The event name, please see Event Types for a description of the events.
ts	Date ISO String	A timestamp in ISO format (eg, "2021-08-09T16:45:57.000Z")
message	string	A human-friendly message describing the event.
id	string	The unique 6 or 12 character base62 session id.
label	string	A subject / description for this session.
userDescription	string	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.
status	string enum	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).
user	object	Information about the agent who created this session
organization	object	Information about the agent's organization which created this session.
settings	object	A set of name-value pairs of settings that were used to create this session (mapped from AgentPrefs).
createdByAgentSession	object	A descriptor of the ScreenMeet user's authenticated session that was used to create this session.
crmSyncTarget	object	A description of the related entity in an external system if the session was created via an integration.
device	object	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.
stats	object	The stats object contains various statistics and metadata about the session.
seconds	int	How many seconds into the session did this event occur
servers	object	A description of which ScreenMeet servers were used to facilitate the session.
storedFile	object	Metadata about file that was uploaded to storage. Only applies to file-uploaded-to-storage event.

Event Types

Event Type	Products	Description
session-created	all	Session was created by a ScreenMeet agent
session-closed	all	Session has ended
video-stream-started	support	User started streaming their desktop
chat	all	Chat message sent in-session
user-connected	support, cobrowse	End-user has connected to the session
user-disconnected	support, cobrowse	End-user had disconnected from the session
session-ending	support	Session shut-down has been initiated and it will be closed shortly
agent-joined	support	A ScreenMeet agent has joined the session
client-event	support	A log event was sent by the end-user's client
clipboard-link-on	support	Clipboard linking was activated by ScreenMeet Agent
agent-left	support	Agent has disconnected from the session
remote-control-requested	support	Agent has requested remote control of end-user's device
remote-control-granted	support	End-user has granted remote control to the agent
remote-control-stopped	support	Remote control of end-user's device has stopped
uac-requested	support	Admin permission requested on end-user's device
uac-permission-granted	support	Admin permission granted on end-user's device
uac-permission-denied	support	Admin permission denied on end-user's device
remote-execute	support	A remote macro / command was executed on user's device
file-uploaded	all	A file was uploaded to the server
file-uploaded-to-storage	all	A file was uploaded to permanent storage
url-navigate	cobrowse	User has navigated to this URL
session-rating	all	Agent submitted a session rating after the session
session-server-selected	all	A server was selected to host the session
microphone-access-requested	live	Permission to acquire audio stream from a user's microphone was requested
camera-access-requested	live	Permission to acquire audio stream from a user's camera was requested
camera-access-succeeded	live	Video stream from a user's camera was acquired
microphone-access-succeeded	live	Audio stream from a user's microphone was acquired
entered-lobby	live	A user has entered the meeting lobby
user-joined	live	A user has joined the meeting
user-left	live	A user has departed the meeting
audio-muted	live	A user muted their audio stream
audio-resumed	live	A user unmuted their audio stream
desktop-access-requested	live	Permission to acquire video stream from a user's desktop was requested
desktop-access-succeeded	live	Video stream from a user's desktop was acquired
microphone-access-error	live	An error occurred while acquiring the user's audio stream
camera-access-error	live	An error occurred while acquiring the user's camera video stream
session-feedback	all	A ScreenMeet agent submitted feedback on the session quality after it ended
record-toggled	live	Recording was toggled for a live session
desktop-access-error	live	An error occurred while acquiring the user's desktop video stream
room-entry-requested	live	A user requested entry into the room
file-download	all	A stored recording or file was downloaded via the ScreenMeet console
session-data-expired	all	ScreenMeet's data retention policy has purged data for this session
agent-connected	cobrowse	A ScreenMeet agent connected to the session
agent-disconnected	cobrowse	A ScreenMeet agent disconnected to the session
page-focus	cobrowse	The user's browser has focused on a page that is being cobrowsed
cb-dialog-pin-entered	cobrowse	The user has entered a PIN into the cobrowse modal dialog
remote-control-permission-request	cobrowse	Remote control permission was requested from the user
remote-control-permission-granted	cobrowse	Remote control permission was granted by the user
remote-control-permission-denied	cobrowse	Remote control permission was denied by the user

Sample Event Objects

Cobrowse Event

{
    "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
  }

File Uploaded to Storage

  {
    "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": {}
  }

PreviousConfiguring Webhooks for Data Sync