Skip to main content

Powerups

  • Alert key: twitch-powerups
  • Source: Twitch
  • Event list label: Powerups
  • Carries alert image: yes (extraSettings.contentImage)

Default message template

{{username}} redeemed {{type}} and cheered {{amount}} bits. They said {{message}}

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
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{type}}data.extraSettings.typeNo description available yet.
{{amount}}data.extraSettings.amountThe amount sent
{{message}}data.extraSettings.messageThe message text sent by the user
{{reward_id}}data.extraSettings.reward_idNo description available yet.
{{powerup_source}}data.extraSettings.powerup_sourceNo description available yet.

Example payloads

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

Gigantify powerup

{
"alert": "twitch-powerups",
"dynamic": {
"value": 100,
"name": "gigantify_an_emote"
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"type": "gigantify_an_emote",
"amount": 100,
"contentImage": "https://static-cdn.jtvnw.net/twitch-power-ups/gigantify_an_emote/black/v1/default_2x.png",
"message": "",
"reward_id": "",
"powerup_source": ""
}
}

Celebration powerup

{
"alert": "twitch-powerups",
"dynamic": {
"value": 500,
"name": "celebration"
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"type": "celebration",
"amount": 500,
"contentImage": "https://static-cdn.jtvnw.net/twitch-power-ups/celebration/black/v1/default_2x.png",
"message": "",
"reward_id": "",
"powerup_source": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_USERNAME - Username is equal to
  • EQUAL_SELECTION - Custom Powerup Selection
  • EQUAL_STRING - Custom Powerup Title is equal to
  • EQUAL_NUMBER - Bits Amount is equal to
  • GREATER_NUMBER - Bits Amount is greater than or equal to
  • EQUAL_VARIABLE - Variable is equal to