`Twitch.SharedChatSessionUpdate`

WebSocket event schema, payload, and examples

Properties

host

object required

isTest

boolean required

participants

TwitchBaseUser[]

sessionId

string

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": "#/$defs/TwitchBaseUser"
        }
      ]
    },
    "sessionId": {
      "type": [
        "null",
        "string"
      ]
    },
    "isTest": {
      "type": "boolean"
    },
    "participants": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/TwitchBaseUser"
      }
    }
  },
  "$defs": {
    "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": {},
  "sessionId": null,
  "isTest": true,
  "participants": [
    {
      "id": "du42cn7ku",
      "login": null,
      "name": null,
      "type": null
    },
    {
      "id": "z",
      "login": "",
      "name": "RjwXQPRGq",
      "type": null
    },
    {
      "id": "HzU",
      "login": null,
      "name": "7gOk7",
      "type": null
    },
    {
      "id": "C5x",
      "login": "J",
      "name": null,
      "type": ""
    },
    {
      "id": "",
      "login": "Wvq8X2",
      "name": "wl",
      "type": 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);
});