Webhook Data Dictionary

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

Event Types

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