Twitch.Cheer

Someone cheers bits.

• Platform: twitch
• Shape: cheer
• Source event: Twitch.Cheer

Usage

Widget.on("Twitch.Cheer", (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.
• amount (number): Bits, or the amount in its currency.
• currency (string): «bits» on Twitch; the currency code (USD, MXN…) on YouTube.
• message (string): The message, as plain text.
• parts (MessagePart[]): The message in parts (text, emotes and cheers), for Widget.dom.renderMessage.
• anonymous (boolean): Whether the gift is anonymous.

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

Example

The example payload that reaches the Studio simulator:

{
  "user": {
    "role": 1,
    "badges": [],
    "color": "#9ACD32",
    "subscribed": false,
    "monthsSubscribed": 0,
    "id": "100000003",
    "login": "eltacoloco",
    "name": "ElTacoLoco",
    "type": "twitch"
  },
  "messageId": "00000000-0000-4000-8000-000000000002",
  "meta": {
    "internal": false,
    "firstMessage": false,
    "firstMessageTimestamp": "2026-09-10T17:12:38.3069493-06:00",
    "returningChatter": false,
    "isHighlighted": false,
    "isMe": false,
    "isCustomReward": false,
    "isInSharedChat": false,
    "isSharedChatHost": false,
    "isFromSharedChatGuest": false,
    "createdAt": "2026-09-26T05:33:02.4127730Z",
    "isTest": false
  },
  "anonymous": false,
  "text": "Cheer100 ¡vamos!",
  "emotes": [],
  "parts": [
    {
      "bits": 100,
      "color": "#9c3ee8",
      "imageUrl": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/100/4.gif",
      "zeroWidth": false,
      "type": "cheer",
      "text": "Cheer100"
    },
    {
      "type": "text",
      "text": " ¡vamos!"
    }
  ],
  "isReply": false,
  "reply": null,
  "sharedChatSource": null,
  "broadcaster": {
    "id": "100000000",
    "login": "canaldeprueba",
    "name": "CanalDePrueba",
    "type": "twitch"
  },
  "isInSharedChat": false,
  "isSharedChatHost": false,
  "isFromSharedChatGuest": false,
  "createdAt": "2026-09-26T05:33:02.4127730Z",
  "isTest": false,
  "bits": 100,
  "cheerEmotes": [
    {
      "bits": 100,
      "color": "#9c3ee8",
      "type": "CheerEmote",
      "name": "Cheer",
      "startIndex": 0,
      "endIndex": 8,
      "imageUrl": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/100/4.gif"
    }
  ]
}