Twitch.BotWhisper
WebSocket event schema, payload, and examples
user
object required
id
string
login
string
name
string
type
string
whisperId
string
whisperText
string
isTest
boolean required
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "TwitchUserWhisperMessageEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"user": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchBaseUser"
}
]
},
"whisperId": {
"type": [
"null",
"string"
]
},
"whisperText": {
"type": [
"null",
"string"
]
},
"isTest": {
"type": "boolean"
}
},
"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
{
"isTest": false,
"user": null,
"whisperId": "deserunt cillum",
"whisperText": 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.BotWhisper" events and register a callback
client.on('Twitch.BotWhisper', ({ 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);
});