Bits
- Alert key:
twitch-bits - Source: Twitch
- Event list label: Bits
- Carries alert image: yes (
extraSettings.contentImage)
Default message template
{{username}} 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 variable | Overlay payload field | Description |
|---|---|---|
{{username}} | data.extraSettings.username | The username of the sender |
{{avatar}} | data.extraSettings.avatar | The url of the avatar of the sender for a message |
{{amount}} | data.extraSettings.amount | The amount sent |
{{message}} | data.extraSettings.message | The message text sent by the user |
Example payloads
Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).
100 bits
{
"alert": "twitch-bits",
"dynamic": {
"value": 100
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 100,
"contentImage": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/100/4.gif",
"message": ""
}
}
500 bits
{
"alert": "twitch-bits",
"dynamic": {
"value": 500
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 500,
"contentImage": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/100/4.gif",
"message": ""
}
}
1000 bits
{
"alert": "twitch-bits",
"dynamic": {
"value": 1000
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 1000,
"contentImage": "https://d3aqoihi2n8ty8.cloudfront.net/actions/cheer/dark/animated/1000/4.gif",
"message": ""
}
}
Variation conditions
Dimensions you can branch on when configuring alert variations:
RANDOMEQUAL_USERNAMEEQUAL_NUMBER- Bits Amount is equal toGREATER_NUMBER- Bits Amount is greater than or equal toEQUAL_VARIABLE
Related
- Alert Explorer - live preview of every alert
- Overlay Type Definitions - full
AlertEventTypeScript type