Donation
- Alert key:
lumiastream-donation - Source: Lumia
- Event list label: Donation
Default message template
{{username}} just tipped {{currencySymbol}}{{amount}}. 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 |
{{sender_social_link}} | data.extraSettings.sender_social_link | No description available yet. |
{{currency}} | data.extraSettings.currency | The currency used |
{{currencySymbol}} | data.extraSettings.currencySymbol | The currency symbol used |
{{amount}} | data.extraSettings.amount | The amount sent |
{{message}} | data.extraSettings.message | The message text sent by the user |
{{anonymous}} | data.extraSettings.anonymous | No description available yet. |
{{command}} | data.extraSettings.command | The command that was triggered for the message |
Example payloads
Each scenario below mirrors what Lumia emits in Overlay.on('alert', (data) => …).
$100
{
"alert": "lumiastream-donation",
"dynamic": {
"value": 100,
"currency": "USD"
},
"extraSettings": {
"username": "lumiastream",
"sender_social_link": "https://twitch.tv/lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 100,
"currency": "USD",
"anonymous": false,
"currencySymbol": "",
"message": "",
"command": ""
}
}
$200
{
"alert": "lumiastream-donation",
"dynamic": {
"value": 200,
"currency": "USD"
},
"extraSettings": {
"username": "lumiastream",
"sender_social_link": "https://twitch.tv/lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 200,
"currency": "USD",
"anonymous": false,
"currencySymbol": "",
"message": "",
"command": ""
}
}
$300
{
"alert": "lumiastream-donation",
"dynamic": {
"value": 300,
"currency": "USD"
},
"extraSettings": {
"username": "lumiastream",
"sender_social_link": "https://twitch.tv/lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"amount": 300,
"currency": "USD",
"anonymous": false,
"currencySymbol": "",
"message": "",
"command": ""
}
}
Variation conditions
Dimensions you can branch on when configuring alert variations:
RANDOMEQUAL_USERNAMEEQUAL_CURRENCY_NUMBER- Donation Amount is equal toGREATER_CURRENCY_NUMBER- Donation Amount is greater than or equal toEQUAL_VARIABLE
Related
- Alert Explorer - live preview of every alert
- Overlay Type Definitions - full
AlertEventTypeScript type