Kick.ChatMessage

A chat message.

• Platform: kick
• Shape: chat
• Source event: Kick.ChatMessage

Usage

Widget.on("Kick.ChatMessage", (event) => {
  // event.user, event.platform…
});

Fields

• user (string): Display name; «Anonymous» for anonymous gifts.
• userId (string): User id on its platform.
• userLogin (string): Login, lowercase.
• color (string): Name color (#RRGGBB) or empty.
• role (1 | 2 | 3 | 4): 1 viewer, 2 VIP, 3 moderator, 4 broadcaster.
• badges (ChatBadge[]): Badges, with their image.
• message (string): The message, as plain text.
• parts (MessagePart[]): The message in parts (text, emotes and cheers), for Widget.dom.renderMessage.
• messageId (string): Message id; the one messageDeleted carries.
• firstMessage (boolean): First message in the channel.
• highlighted (boolean): Highlighted with channel points.
• reply (ChatReply | null): Who it replies to, or null.

It also carries platform (the source platform) and raw (the original payload).

Example

The example payload that reaches the Studio simulator:

{
  "FirstMessage": "string",
  "isReply": false,
  "isTest": false,
  "messageId": "0000010000001001",
  "parts": [],
  "reply": {
    "content": "string",
    "messageId": "string",
    "sender": {
      "badges": [
        {
          "id": "00000001000001001",
          "imageUrl": "string",
          "name": "string"
        }
      ],
      "color": "string",
      "id": "00000001000001001",
      "isSubscribed": false,
      "isVerified": false,
      "login": "string",
      "name": "string",
      "profilePicture": "string",
      "role": 1
    }
  },
  "text": "string",
  "user": {
    "badges": [
      {
        "id": "00000001000001001",
        "imageUrl": "string",
        "name": "string"
      }
    ],
    "color": "string",
    "id": "00000001000001001",
    "isSubscribed": false,
    "isVerified": false,
    "login": "string",
    "monthsSubscribed": 1,
    "name": "string",
    "profilePicture": "string",
    "role": 1
  }
}