`Kick.ChatMessage`

WebSocket event schema, payload, and examples

Properties

isAnonymous

boolean required

user

KickUser required

messageId

string

parts

KickPartBase[]

text

string

isReply

boolean required

KickReplyData required

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": "#/$defs/KickUser"
        }
      ]
    },
    "messageId": {
      "type": [
        "null",
        "string"
      ]
    },
    "parts": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/KickPartBase"
      }
    },
    "text": {
      "type": [
        "null",
        "string"
      ]
    },
    "isReply": {
      "type": "boolean"
    },
    "reply": {
      "oneOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/KickReplyData"
        }
      ]
    },
    "isInternal": {
      "type": "boolean"
    },
    "isTest": {
      "type": "boolean"
    }
  },
  "$defs": {
    "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": "#/$defs/ViewerRole"
        },
        "isSubscribed": {
          "type": "boolean"
        },
        "badges": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/KickUserBadge"
          }
        },
        "color": {
          "type": [
            "null",
            "string"
          ]
        },
        "monthsSubscribed": {
          "type": "integer"
        },
        "isVerified": {
          "type": [
            "boolean",
            "null"
          ]
        }
      }
    },
    "ViewerRole": {
      "type": "integer",
      "description": "",
      "x-enum-names": [
        "Unknown",
        "Viewer",
        "Vip",
        "Moderator",
        "Broadcaster"
      ],
      "x-enum-descriptions": [
        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": "#/$defs/KickUser"
            }
          ]
        }
      }
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker

example.json

{
  "isAnonymous": false,
  "user": null,
  "messageId": null,
  "parts": [
    {
      "type": null,
      "text": null
    },
    {
      "type": "zLyd",
      "text": null
    },
    {
      "type": "r0J1e",
      "text": "D84GRUQk"
    },
    {
      "type": "tUV8",
      "text": null
    },
    {
      "type": "DIcNvuCPT",
      "text": null
    }
  ],
  "text": null,
  "isReply": true,
  "reply": null,
  "isInternal": true,
  "isTest": true
}

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);
});