Skip to main content

Treat

  • Alert key: treatstream-treat
  • Source: TreatStream
  • Event list label: Treat

Default message template

{{username}} sent {{treat}}

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
{{treat}}data.extraSettings.treatTreat sent

Example payloads

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

Lumia Treats

{
"alert": "treatstream-treat",
"dynamic": {
"value": "Lumia Treats"
},
"extraSettings": {
"treat": "Lumia Treats",
"username": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Treat is equal to
  • EQUAL_VARIABLE