Webhook Data Dictionary

Webhook Data Dictionary

Overview

This article defines the fields and event types ScreenMeet sends in webhook payloads. Use it to parse webhook events, track session state, and sync session data into an external system such as a CRM or ticketing platform.

To create a webhook and verify its signature, see Configuring Webhooks for Data Sync.

Payload Format

Every webhook request body is a JSON array containing one or more event objects. The body is an array even when it contains a single event, so always iterate over it.

Each event is a denormalized JSON object. Not every event contains every field, so treat the data as sparse and check for a field before reading it.

Event Fields

Session Status Values

Detecting Session Start and End

To track whether a session is in progress, act on two event types and ignore the rest.

Match events to your own records using id. If your application shares the session link, store the session ID from that link when it is sent.

Event Types

Event types are grouped by the products that emit them. This list may not include every event ScreenMeet sends. Ignore any event type your application does not recognize.

All Products

Live

Remote Support

CoBrowse

Stats Object

The stats object is populated when the session closes. Fields vary by product.

Sample Payloads

The samples below are trimmed for readability. Values are placeholders.

Live Session Closed

[
  {
    "id": "AbCdEfGhIjKl",
    "pin": 123456,
    "label": "Case 00012345",
    "userDescription": "Alex",
    "status": "closed",
    "sessionType": "live",
    "settings": {
      "audio": true,
      "knock": false,
      "recording": false,
      "guest_video": false,
      "startwithrc": false,
      "startwithadmin": false
    },
    "stats": {
      "streamtype": "live",
      "duration": 15,
      "duration-connected": 15,
      "duration-idle": 0,
      "time-ended": "2026-01-01T15:00:00.000Z",
      "max-concurrent-viewers": 1,
      "sum-user-seconds": 0,
      "metrics": {},
      "termination-reason": "closed by agent"
    },
    "servers": {
      "live": {
        "id": 470000,
        "region": "us-east-1",
        "endpoint": "https://live-prod-470000.screenmeet.com",
        "serverInstanceId": "i-0123456789abcdef0"
      }
    },
    "organization": { "id": 1000, "name": "Example Org" },
    "user": { "id": 2000, "name": "Alex Agent", "email": "agent@example.com" },
    "crmSyncTarget": {},
    "ts": "2026-01-01T15:00:00.150Z",
    "type": "session-closed",
    "message": "Session AbCdEfGhIjKl has been closed."
  }
]

Live Session Activated

[
  {
    "id": "AbCdEfGhIjKl",
    "pin": 123456,
    "label": "Case 00012345",
    "status": "active",
    "sessionType": "live",
    "stats": null,
    "ts": 1767279585000,
    "type": "session-activated",
    "message": "live session state is now active"
  }
]

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",
            "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": {
        "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 }
      }
    },
    "servers": {
      "cobrowse": {
        "id": 12327,
        "endpoint": "https://cb-12327.screenmeet.com:443",
        "use_proxy": true,
        "proxy_endpoint": "https://rt-proxy.screenmeet.com"
      },
      "recorder": { "id": 11590 }
    },
    "pin": 218560,
    "organization": { "id": 265, "provider": "sfdc", "name": "ScreenMeet Developer Org" },
    "user": { "id": 9916, "email": "joe@example.com", "name": "Joe Smith" },
    "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",
      "os_name": "Mac OS",
      "os_version": "10.15.7"
    },
    "seconds": 1
  }
]

File Uploaded to Storage

[
  {
    "organization": { "id": 265, "provider": "sfdc", "name": "ScreenMeet Developer Org" },
    "user": { "id": 9916, "email": "joe@example.com", "name": "Joe Smith" },
    "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]",
    "crmSyncTarget": {}
  }
]

Related Articles

• Configuring Webhooks for Data Sync
• ScreenMeet API: Poll Session State