`Twitch.SharedChatSessionBegin`

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": "TwitchSharedChatSessionBeginEvent",
  "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": "irure",
      "login": "aliqua",
      "name": "in",
      "type": null
    },
    {
      "id": null,
      "login": "irure Excepteur est veniam",
      "name": "qui",
      "type": null
    },
    {
      "id": null,
      "login": "ut Lorem labore sit",
      "name": null,
      "type": "quis incididunt consectetur"
    },
    {
      "id": "voluptate aliquip reprehenderit Ut ex",
      "login": "Excepteur sint do",
      "name": null,
      "type": null
    },
    {
      "id": null,
      "login": null,
      "name": "commodo",
      "type": null
    }
  ],
  "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.SharedChatSessionBegin" events and register a callback
client.on('Twitch.SharedChatSessionBegin', ({ 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);
});