Kick.ChatMessage

WebSocket event schema, payload, and examples

Properties

isAnonymous
boolean required
user
object required
messageId
string
parts
KickPartBase[]
text
string
isReply
boolean required
reply
object 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": "#/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": false,
  "isInternal": true,
  "isReply": true,
  "isTest": true,
  "messageId": "non dolor",
  "parts": [
    {
      "text": "dolore",
      "type": "esse nisi tempor"
    },
    {
      "text": "voluptate",
      "type": null
    },
    {
      "text": null,
      "type": null
    },
    {
      "text": "velit minim sint",
      "type": null
    },
    {
      "text": null,
      "type": null
    }
  ],
  "reply": {
    "content": "dolore",
    "messageId": "cupidatat aliquip nostrud ad",
    "sender": {
      "badges": null,
      "color": "consequat in quis",
      "id": null,
      "isSubscribed": false,
      "isVerified": false,
      "login": "irure pariatur incididunt officia ullamco",
      "monthsSubscribed": 70427990,
      "name": "consectetur sint sed",
      "profilePicture": "amet ad labore",
      "role": 2,
      "type": "proident consectetur"
    }
  },
  "text": null,
  "user": {
    "badges": [
      {
        "id": "Ut ut",
        "imageUrl": "incididunt aliqua consequat",
        "info": null,
        "name": "do sit esse tempor"
      },
      {
        "id": null,
        "imageUrl": "aliquip nostrud ea",
        "info": "Ut",
        "name": null
      },
      {
        "id": "reprehenderit minim",
        "imageUrl": null,
        "info": "Ut",
        "name": "labore"
      },
      {
        "id": "ad",
        "imageUrl": "sed in",
        "info": null,
        "name": null
      },
      {
        "id": "in sed ut reprehenderit",
        "imageUrl": "ea proident",
        "info": null,
        "name": "cillum dolore enim deserunt"
      }
    ],
    "color": null,
    "id": "in velit",
    "isSubscribed": true,
    "isVerified": null,
    "login": null,
    "monthsSubscribed": 25760700,
    "name": "sit quis aliquip nisi",
    "profilePicture": "consequat nulla ipsum est",
    "role": {},
    "type": "est minim eu et"
  }
}

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