Session Superchats
- Alert key:
youtube-sessionSuperchats - Source: YouTube
- Event list label: Total Superchat
{{currencySymbol}}``{{total}}
Default message template
Reached {{currencySymbol}}{{total}} of superchats
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 |
|---|---|---|
{{total}} | data.extraSettings.total | Hype train current total |
{{previousTotal}} | data.extraSettings.previousTotal | No description available yet. |
{{currency}} | data.extraSettings.currency | The currency used |
{{currencySymbol}} | data.extraSettings.currencySymbol | The currency symbol used |
Example payloads
Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).
10 Total Superchats
{
"alert": "youtube-sessionSuperchats",
"dynamic": {
"value": 10,
"total": 10,
"previousTotal": 5
},
"extraSettings": {
"total": 10,
"previousTotal": 5,
"currency": "",
"currencySymbol": ""
}
}
50 Total Superchats
{
"alert": "youtube-sessionSuperchats",
"dynamic": {
"value": 50,
"total": 50,
"previousTotal": 2
},
"extraSettings": {
"total": 50,
"previousTotal": 2,
"currency": "",
"currencySymbol": ""
}
}
100 Total Superchats
{
"alert": "youtube-sessionSuperchats",
"dynamic": {
"value": 100,
"total": 100,
"previousTotal": 50
},
"extraSettings": {
"total": 100,
"previousTotal": 50,
"currency": "",
"currencySymbol": ""
}
}
Variation conditions
Dimensions you can branch on when configuring alert variations:
GREATER_NUMBER- Total Session Superchats is greater than or equal toCOUNT_IS_MULTIPLE_OF- Total Session Superchats is a multiple of
Related
- Alert Explorer - live preview of every alert
- Overlay Type Definitions - full
AlertEventTypeScript type