Banned

• Alert key: twitch-banned
• Source: Twitch
• Event list label: Banned

Default message template

{{username}} is banned

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
{{userId}}	data.extraSettings.userId	The user ID of the sender
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message
{{reason}}	data.extraSettings.reason	Ban Reason, e.g. this will get the reason when using /ban [username] [reason]

Example payloads

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

Banned

{
  "alert": "twitch-banned",
  "dynamic": {
    "value": "lumiastream"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "reason": "For being too bright",
    "userId": ""
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_USERNAME
• EQUAL_VARIABLE

Related

• Alert Explorer - live preview of every alert
• Overlay Type Definitions - full AlertEvent TypeScript type