Twitch.SharedChatUserBanned
WebSocket event schema, payload, and examples
moderator
object required
id
string
login
string
name
string
type
string
source
object required
id
string
login
string
name
string
type
string
isTest
boolean required
isInSharedChat
boolean required
isSharedChatHost
boolean required
isFromSharedChatGuest
boolean required
targetUser
object required
id
string
login
string
name
string
type
string
reason
string
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "TwitchChannelModerateSharedBanEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"moderator": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchBaseUser"
}
]
},
"source": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchBaseUser"
}
]
},
"isTest": {
"type": "boolean"
},
"isInSharedChat": {
"type": "boolean"
},
"isSharedChatHost": {
"type": "boolean"
},
"isFromSharedChatGuest": {
"type": "boolean"
},
"targetUser": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchBaseUser"
}
]
},
"reason": {
"type": [
"null",
"string"
]
}
},
"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
{
"isFromSharedChatGuest": true,
"isInSharedChat": false,
"isSharedChatHost": false,
"isTest": true,
"moderator": null,
"reason": "adipisicing",
"source": {
"id": null,
"login": "consectetur quis ipsum in",
"name": null,
"type": "voluptate exercitation cupidatat reprehenderit"
},
"targetUser": 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.SharedChatUserBanned" events and register a callback
client.on('Twitch.SharedChatUserBanned', ({ 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);
});