Kick.ChatMessage
WebSocket event schema, payload, and examples
isAnonymous
boolean required
user
object required
id
string
login
string
name
string
type
string
profilePicture
string
role
integer required
Value | Name |
---|---|
0 | Unknown |
1 | Viewer |
2 | Vip |
3 | Moderator |
4 | Broadcaster |
isSubscribed
boolean required
badges
KickUserBadge[]
id
string
name
string
info
string
imageUrl
string
color
string
monthsSubscribed
integer required
isVerified
boolean
messageId
string
parts
KickPartBase[]
type
string
text
string
text
string
isReply
boolean required
reply
object required
messageId
string
content
string
sender
object required
id
string
login
string
name
string
type
string
profilePicture
string
role
integer required
Value | Name |
---|---|
0 | Unknown |
1 | Viewer |
2 | Vip |
3 | Moderator |
4 | Broadcaster |
isSubscribed
boolean required
badges
KickUserBadge[]
id
string
name
string
info
string
imageUrl
string
color
string
monthsSubscribed
integer required
isVerified
boolean
isInternal
boolean required
isTest
boolean required
Schema
The JSON Schema for the event payload, if available.
schema.json
{
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "KickFirstWordEvent",
"type": "object",
"additionalProperties": false,
"properties": {
"isAnonymous": {
"type": "boolean"
},
"user": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/KickUser"
}
]
},
"messageId": {
"type": [
"null",
"string"
]
},
"parts": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/KickPartBase"
}
},
"text": {
"type": [
"null",
"string"
]
},
"isReply": {
"type": "boolean"
},
"reply": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/KickReplyData"
}
]
},
"isInternal": {
"type": "boolean"
},
"isTest": {
"type": "boolean"
}
},
"definitions": {
"KickUser": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"login": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"type": {
"type": [
"null",
"string"
]
},
"profilePicture": {
"type": [
"null",
"string"
]
},
"role": {
"$ref": "#/definitions/ViewerRole"
},
"isSubscribed": {
"type": "boolean"
},
"badges": {
"type": [
"array",
"null"
],
"items": {
"$ref": "#/definitions/KickUserBadge"
}
},
"color": {
"type": [
"null",
"string"
]
},
"monthsSubscribed": {
"type": "integer",
"format": "int32"
},
"isVerified": {
"type": [
"boolean",
"null"
]
}
}
},
"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
]
},
"KickUserBadge": {
"type": "object",
"additionalProperties": false,
"properties": {
"id": {
"type": [
"null",
"string"
]
},
"name": {
"type": [
"null",
"string"
]
},
"info": {
"type": [
"null",
"string"
]
},
"imageUrl": {
"type": [
"null",
"string"
]
}
}
},
"KickPartBase": {
"type": "object",
"additionalProperties": false,
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"text": {
"type": [
"null",
"string"
]
}
}
},
"KickReplyData": {
"type": "object",
"additionalProperties": false,
"properties": {
"messageId": {
"type": [
"null",
"string"
]
},
"content": {
"type": [
"null",
"string"
]
},
"sender": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/definitions/KickUser"
}
]
}
}
}
}
}
JSON Payload
An example JSON payload for the event, automatically generated using JSONSchemaFaker
example.json
{
"isAnonymous": true,
"isInternal": false,
"isReply": true,
"isTest": true,
"messageId": "eu tempor id labore",
"parts": [
{
"text": null,
"type": "mollit elit veniam"
},
{
"text": "Excepteur sunt dolore",
"type": null
},
{
"text": "sunt aliquip",
"type": null
},
{
"text": null,
"type": "magna eu"
},
{
"text": "cupidatat dolore elit est amet",
"type": null
}
],
"reply": {
"content": null,
"messageId": null,
"sender": null
},
"text": "quis in ipsum eiusmod",
"user": 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 "Kick.ChatMessage" events and register a callback
client.on('Kick.ChatMessage', ({ 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);
});