Twitch.SharedChatSessionUpdate

WebSocket event schema, payload, and examples

Properties

host
object required
sessionId
string
isTest
boolean required
participants
TwitchBaseUser[]

Schema

The JSON Schema for the event payload, if available.
schema.json
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "TwitchSharedChatSessionUpdateEvent",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "host": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/definitions/TwitchBaseUser"
        }
      ]
    },
    "sessionId": {
      "type": [
        "null",
        "string"
      ]
    },
    "isTest": {
      "type": "boolean"
    },
    "participants": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/definitions/TwitchBaseUser"
      }
    }
  },
  "definitions": {
    "TwitchBaseUser": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "type": [
            "null",
            "string"
          ]
        },
        "login": {
          "type": [
            "null",
            "string"
          ]
        },
        "name": {
          "type": [
            "null",
            "string"
          ]
        },
        "type": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
  "host": null,
  "isTest": true,
  "participants": [
    {
      "id": null,
      "login": null,
      "name": "mollit fugiat eiusmod",
      "type": null
    },
    {
      "id": "commodo qui mollit",
      "login": null,
      "name": null,
      "type": "sunt et consequat voluptate in"
    },
    {
      "id": "nulla ea adipisicing aliqua",
      "login": "dolore",
      "name": "id",
      "type": "dolore non laboris pariatur qui"
    },
    {
      "id": "deserunt sed",
      "login": "eu exercitation do",
      "name": "ex nostrud sit non",
      "type": "ea ullamco Ut officia"
    },
    {
      "id": "veniam sit eu",
      "login": "non aliquip elit",
      "name": null,
      "type": "cillum"
    }
  ],
  "sessionId": null
}

Client Example

Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client
index.js
// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();

// Subscribe to "Twitch.SharedChatSessionUpdate" events and register a callback
client.on('Twitch.SharedChatSessionUpdate', ({ event, data }) => {
  // Code here will run every time the event is received!
  console.log('Received event:', event.source, event.type);
  console.log('Event data:', data);
});