Twitch.Cheer
WebSocket event schema, payload, and examples
message
object required
internal
boolean required
msgId
string
clientNonce
string
userId
string
username
string
role
integer required
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | Viewer |
| 2 | Vip |
| 3 | Moderator |
| 4 | Broadcaster |
subscriber
boolean required
subscriptionTier
string
displayName
string
color
string
channel
string
message
string
isHighlighted
boolean required
isMe
boolean required
isCustomReward
boolean required
isAnonymous
boolean required
isReply
boolean required
reply
object required
userId
string
userLogin
string
userName
string
msgId
string
msgBody
string
threadMsgId
string
threadUserLogin
string
bits
integer required
firstMessage
boolean required
returningChatter
boolean required
hasBits
boolean required
emotes
Emote[]
type
string
name
string
startIndex
integer required
endIndex
integer required
imageUrl
string
cheerEmotes
CheerEmote[]
type
string
name
string
startIndex
integer required
endIndex
integer required
imageUrl
string
bits
integer required
color
string
badges
Badge[]
name
string
version
string
imageUrl
string
info
string
monthsSubscribed
integer required
isTest
boolean required
isInSharedChat
boolean required
isFromSharedChatGuest
boolean required
sourceRoomId
string
sourceMsgId
string
sourceBadges
Badge[]
name
string
version
string
imageUrl
string
info
string
user
object required
id
string
login
string
name
string
type
string
role
integer required
| Value | Name |
|---|---|
| 0 | Unknown |
| 1 | Viewer |
| 2 | Vip |
| 3 | Moderator |
| 4 | Broadcaster |
badges
TwitchBadge[]
name
string
version
string
imageUrl
string
info
string
color
string
subscribed
boolean required
subscriptionTier
string
monthsSubscribed
integer required
messageId
string
meta
object required
internal
boolean required
clientNonce
string
firstMessage
boolean required
returningChatter
boolean required
isHighlighted
boolean required
isMe
boolean required
isCustomReward
boolean required
isTest
boolean required
anonymous
boolean required
text
string
emotes
Emote[]
type
string
name
string
startIndex
integer required
endIndex
integer required
imageUrl
string
parts
TwitchMessagePartBase[]
type
string
text
string
isReply
boolean required
reply
object required
msgId
string
userId
string
userLogin
string
userName
string
msgBody
string
threadMsgId
string
threadUserLogin
string
isTest
boolean required
sharedChatSource
object required
id
string
login
string
name
string
type
string
isInSharedChat
boolean required
isSharedChatHost
boolean required
isFromSharedChatGuest
boolean required
bits
integer required
cheerEmotes
CheerEmote[]
type
string
name
string
startIndex
integer required
endIndex
integer required
imageUrl
string
bits
integer required
color
string
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "TwitchCheerEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"message": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ChatMessage"
}
]
},
"user": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchUser"
}
]
},
"messageId": {
"type": [
"null",
"string"
]
},
"meta": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchMessageMetaData"
}
]
},
"anonymous": {
"type": "boolean"
},
"text": {
"type": [
"null",
"string"
]
},
"emotes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/Emote"
}
},
"parts": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/TwitchMessagePartBase"
}
},
"isReply": {
"type": "boolean"
},
"reply": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchMessageReply"
}
]
},
"isTest": {
"type": "boolean"
},
"sharedChatSource": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/TwitchBaseUser"
}
]
},
"isInSharedChat": {
"type": "boolean"
},
"isSharedChatHost": {
"type": "boolean"
},
"isFromSharedChatGuest": {
"type": "boolean"
},
"bits": {
"type": "integer",
"format": "int32"
},
"cheerEmotes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CheerEmote"
}
}
},
"definitions": {
"ChatMessage": {
"type": "object",
"additionalProperties": false,
"properties": {
"internal": {
"type": "boolean"
},
"msgId": {
"type": [
"null",
"string"
]
},
"clientNonce": {
"type": [
"null",
"string"
]
},
"userId": {
"type": [
"null",
"string"
]
},
"username": {
"type": [
"null",
"string"
]
},
"role": {
"$ref": "#/definitions/ViewerRole"
},
"subscriber": {
"type": "boolean"
},
"subscriptionTier": {
"type": [
"null",
"string"
]
},
"displayName": {
"type": [
"null",
"string"
]
},
"color": {
"type": [
"null",
"string"
]
},
"channel": {
"type": [
"null",
"string"
]
},
"message": {
"type": [
"null",
"string"
]
},
"isHighlighted": {
"type": "boolean"
},
"isMe": {
"type": "boolean"
},
"isCustomReward": {
"type": "boolean"
},
"isAnonymous": {
"type": "boolean"
},
"isReply": {
"type": "boolean"
},
"reply": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/ReplyData"
}
]
},
"bits": {
"type": "integer",
"format": "int32"
},
"firstMessage": {
"type": "boolean"
},
"returningChatter": {
"type": "boolean"
},
"hasBits": {
"type": "boolean"
},
"emotes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/Emote"
}
},
"cheerEmotes": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/CheerEmote"
}
},
"badges": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/Badge"
}
},
"monthsSubscribed": {
"type": "integer",
"format": "int32"
},
"isTest": {
"type": "boolean"
},
"isInSharedChat": {
"type": "boolean"
},
"isFromSharedChatGuest": {
"type": "boolean"
},
"sourceRoomId": {
"type": [
"null",
"string"
]
},
"sourceMsgId": {
"type": [
"null",
"string"
]
},
"sourceBadges": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/Badge"
}
}
}
},
"ViewerRole": {
"type": "integer",
"description": "",
"x-enum-names": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-varnames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enumNames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-descriptions": [
null,
null,
null,
null,
null
],
"x-enumDescriptions": [
null,
null,
null,
null,
null
],
"enum": [
0,
1,
2,
3,
4
]
},
"ReplyData": {
"type": "object",
"additionalProperties": false,
"properties": {
"userId": {
"type": [
"null",
"string"
]
},
"userLogin": {
"type": [
"null",
"string"
]
},
"userName": {
"type": [
"null",
"string"
]
},
"msgId": {
"type": [
"null",
"string"
]
},
"msgBody": {
"type": [
"null",
"string"
]
},
"threadMsgId": {
"type": [
"null",
"string"
]
},
"threadUserLogin": {
"type": [
"null",
"string"
]
}
}
},
"Emote": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"endIndex": {
"type": "integer",
"format": "int32"
},
"imageUrl": {
"type": [
"null",
"string"
]
}
}
},
"CheerEmote": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"startIndex": {
"type": "integer",
"format": "int32"
},
"endIndex": {
"type": "integer",
"format": "int32"
},
"imageUrl": {
"type": [
"null",
"string"
]
},
"bits": {
"type": "integer",
"format": "int32"
},
"color": {
"type": [
"null",
"string"
]
}
}
},
"Badge": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"version": {
"type": [
"null",
"string"
]
},
"imageUrl": {
"type": [
"null",
"string"
]
},
"info": {
"type": [
"null",
"string"
]
}
}
},
"TwitchUser": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"login": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": [
"null",
"string"
]
},
"role": {
"$ref": "#/definitions/ViewerRole2"
},
"badges": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/TwitchBadge"
}
},
"color": {
"type": [
"null",
"string"
]
},
"subscribed": {
"type": "boolean"
},
"subscriptionTier": {
"type": [
"null",
"string"
]
},
"monthsSubscribed": {
"type": "integer",
"format": "int32"
}
}
},
"ViewerRole2": {
"type": "integer",
"description": "",
"x-enum-names": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-varnames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enumNames": [
"Unknown",
"Viewer",
"Vip",
"Moderator",
"Broadcaster"
],
"x-enum-descriptions": [
null,
null,
null,
null,
null
],
"x-enumDescriptions": [
null,
null,
null,
null,
null
],
"enum": [
0,
1,
2,
3,
4
]
},
"TwitchBadge": {
"type": "object",
"additionalProperties": false,
"properties": {
"name": {
"type": [
"null",
"string"
]
},
"version": {
"type": [
"null",
"string"
]
},
"imageUrl": {
"type": [
"null",
"string"
]
},
"info": {
"type": [
"null",
"string"
]
}
}
},
"TwitchMessageMetaData": {
"type": "object",
"additionalProperties": false,
"properties": {
"internal": {
"type": "boolean"
},
"clientNonce": {
"type": [
"null",
"string"
]
},
"firstMessage": {
"type": "boolean"
},
"returningChatter": {
"type": "boolean"
},
"isHighlighted": {
"type": "boolean"
},
"isMe": {
"type": "boolean"
},
"isCustomReward": {
"type": "boolean"
},
"isTest": {
"type": "boolean"
}
}
},
"TwitchMessagePartBase": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"text": {
"type": [
"null",
"string"
]
}
}
},
"TwitchMessageReply": {
"type": "object",
"additionalProperties": false,
"properties": {
"msgId": {
"type": [
"null",
"string"
]
},
"userId": {
"type": [
"null",
"string"
]
},
"userLogin": {
"type": [
"null",
"string"
]
},
"userName": {
"type": [
"null",
"string"
]
},
"msgBody": {
"type": [
"null",
"string"
]
},
"threadMsgId": {
"type": [
"null",
"string"
]
},
"threadUserLogin": {
"type": [
"null",
"string"
]
}
}
},
"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
{
"anonymous": true,
"bits": -19694849,
"cheerEmotes": [
{
"bits": -45304154,
"color": null,
"endIndex": 77319499,
"imageUrl": null,
"name": null,
"startIndex": -9181277,
"type": "sed dolore ipsum"
},
{
"bits": -45018155,
"color": "sed voluptate nulla adipisicing",
"endIndex": -8679525,
"imageUrl": null,
"name": "exercitation aliqua",
"startIndex": 39270735,
"type": "Duis"
},
{
"bits": 17746847,
"color": "deserunt dolor amet ut",
"endIndex": -2056219,
"imageUrl": null,
"name": null,
"startIndex": 85410165,
"type": "id"
},
{
"bits": 83417001,
"color": null,
"endIndex": 52476939,
"imageUrl": "consequat magna incididunt occaecat",
"name": "Ut",
"startIndex": 84594392,
"type": null
},
{
"bits": 58129231,
"color": null,
"endIndex": 99165782,
"imageUrl": "minim anim Ut",
"name": null,
"startIndex": 30594214,
"type": null
}
],
"emotes": [
{
"endIndex": -72332961,
"imageUrl": "consectetur",
"name": "elit deserunt",
"startIndex": -93356633,
"type": null
},
{
"endIndex": -68999429,
"imageUrl": "est culpa",
"name": null,
"startIndex": -87314947,
"type": "magna mollit"
},
{
"endIndex": -59972582,
"imageUrl": null,
"name": "consequat",
"startIndex": 40152226,
"type": null
},
{
"endIndex": 76187164,
"imageUrl": null,
"name": null,
"startIndex": 43374796,
"type": null
},
{
"endIndex": 44203163,
"imageUrl": "ut amet ea Ut",
"name": "et labore ipsum cupidatat consectetur",
"startIndex": 38645563,
"type": null
}
],
"isFromSharedChatGuest": true,
"isInSharedChat": false,
"isReply": true,
"isSharedChatHost": true,
"isTest": false,
"message": {
"badges": null,
"bits": 59190600,
"channel": "esse cillum cupidatat proident voluptate",
"cheerEmotes": null,
"clientNonce": "officia sint dolore consequat in",
"color": "dolor tempor ipsum sunt",
"displayName": null,
"emotes": [],
"firstMessage": true,
"hasBits": true,
"internal": false,
"isAnonymous": false,
"isCustomReward": true,
"isFromSharedChatGuest": true,
"isHighlighted": false,
"isInSharedChat": true,
"isMe": true,
"isReply": true,
"isTest": false,
"message": "velit Duis cillum",
"monthsSubscribed": 57316718,
"msgId": null,
"reply": null,
"returningChatter": false,
"role": 4,
"sourceBadges": null,
"sourceMsgId": "sint pariatur",
"sourceRoomId": "aliqua minim",
"subscriber": true,
"subscriptionTier": null,
"userId": "irure Ut officia minim in",
"username": null
},
"messageId": "ut aliqua dolor eu eiusmod",
"meta": null,
"parts": [
{
"text": null,
"type": null
},
{
"text": null,
"type": null
},
{
"text": null,
"type": "nulla ullamco"
},
{
"text": "est laboris",
"type": "ut amet Lorem quis"
},
{
"text": null,
"type": null
}
],
"reply": null,
"sharedChatSource": null,
"text": "ea labore",
"user": {
"badges": [
{
"imageUrl": null,
"info": "sit consectetur laborum in",
"name": "amet in elit",
"version": "amet"
},
{
"imageUrl": null,
"info": null,
"name": null,
"version": "sint velit consectetur nulla"
},
{
"imageUrl": null,
"info": null,
"name": null,
"version": "laboris"
},
{
"imageUrl": "do cupidatat cillum",
"info": null,
"name": "aute laboris dolore",
"version": "Lorem dolore deserunt commodo pariatur"
},
{
"imageUrl": "laborum ex do veniam",
"info": "culpa qui",
"name": null,
"version": "aute sint"
}
],
"color": "Lorem sunt",
"id": "aute veniam eu enim",
"login": "sint qui Ut consectetur",
"monthsSubscribed": 62045541,
"name": null,
"role": 2,
"subscribed": false,
"subscriptionTier": null,
"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.Cheer" events and register a callback
client.on('Twitch.Cheer', ({ 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);
});