Skip to main content

Gifts

  • Alert key: youtube-gifts
  • Source: YouTube
  • Event list label: Gift
  • Carries alert image: yes (extraSettings.contentImage)

Default message template​

{{username}} sent x{{comboCount}} {{giftName}} ({{jewelsAmount}} jewels)

Template variables​

Use any of these in alert text, TTS, or chat templates. The same names appear under data.extraSettings.* when you subscribe via Overlay.on('alert').

Template variableOverlay payload fieldDescription
{{username}}data.extraSettings.usernameThe username of the sender
{{displayname}}data.extraSettings.displaynameThe display name of the sender
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{userId}}data.extraSettings.userIdThe user ID of the sender
{{jewelsAmount}}data.extraSettings.jewelsAmountNo description available yet.
{{totalJewels}}data.extraSettings.totalJewelsNo description available yet.
{{comboCount}}data.extraSettings.comboCountNo description available yet.
{{giftName}}data.extraSettings.giftNameNo description available yet.
{{giftUrl}}data.extraSettings.giftUrlNo description available yet.
{{giftImageUrl}}data.extraSettings.giftImageUrlNo description available yet.
{{giftDurationSeconds}}data.extraSettings.giftDurationSecondsNo description available yet.
{{giftDurationNanos}}data.extraSettings.giftDurationNanosNo description available yet.
{{hasVisualEffect}}data.extraSettings.hasVisualEffectNo description available yet.
{{altText}}data.extraSettings.altTextNo description available yet.
{{language}}data.extraSettings.languageNo description available yet.
{{message}}data.extraSettings.messageThe message text sent by the user

Example payloads​

Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).

10 Jewels​

{
  "alert": "youtube-gifts",
  "dynamic": {
    "value": 10,
    "name": "Heart"
  },
  "extraSettings": {
    "username": "lumiastream",
    "displayname": "LumiaStream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Heart",
    "jewelsAmount": 10,
    "totalJewels": 10,
    "comboCount": 1,
    "hasVisualEffect": false,
    "giftUrl": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "contentImage": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "giftDurationSeconds": 3,
    "giftDurationNanos": 0,
    "altText": "Heart",
    "language": "en_US",
    "userId": "",
    "giftImageUrl": "",
    "message": ""
  }
}

100 Jewels​

{
  "alert": "youtube-gifts",
  "dynamic": {
    "value": 100,
    "name": "Rose"
  },
  "extraSettings": {
    "username": "lumiastream",
    "displayname": "LumiaStream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Rose",
    "jewelsAmount": 100,
    "totalJewels": 100,
    "comboCount": 1,
    "hasVisualEffect": true,
    "giftUrl": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "contentImage": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "giftDurationSeconds": 3,
    "giftDurationNanos": 0,
    "altText": "Rose",
    "language": "en_US",
    "userId": "",
    "giftImageUrl": "",
    "message": ""
  }
}

500 Jewels Combo​

{
  "alert": "youtube-gifts",
  "dynamic": {
    "value": 500,
    "name": "Star"
  },
  "extraSettings": {
    "username": "lumiastream",
    "displayname": "LumiaStream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "giftName": "Star",
    "jewelsAmount": 500,
    "totalJewels": 500,
    "comboCount": 5,
    "hasVisualEffect": true,
    "giftUrl": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "contentImage": "https://www.gstatic.com/youtube/img/pdg/gift/assets/gold_coin_v2_320x320.png",
    "giftDurationSeconds": 3,
    "giftDurationNanos": 0,
    "altText": "Star",
    "language": "en_US",
    "userId": "",
    "giftImageUrl": "",
    "message": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Gift Name is equal to
  • EQUAL_NUMBER - Jewels is equal to
  • GREATER_NUMBER - Jewels is greater than or equal to
  • EQUAL_USERNAME
  • EQUAL_VARIABLE