Alert Explorer
Pick a platform, search for an alert, and inspect the exact payload your overlay receives in Overlay.on('alert', (data) => …). Template variables like {{username}} and {{amount}} map to the same keys under data.extraSettings.
Alerts and events
Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.
Live preview
Alert: crowdcontrol-effect
Message template: {{username}} sent {{effect}}
Overlay payload explorer
data {4}
alert: "crowdcontrol-effect"extraSettings {7}
username: "lumiastream"effect: "Big Light"game: "Lumia Stream"avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"artwork: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"message: "Turn on the lights"duration: 5fromLumia: truedynamic {1}
value: "Big Light"| Template variable | Overlay path | Meaning | Example values |
|---|---|---|---|
{{username}} | data.extraSettings.username | The username of the sender | lumiastream |
{{displayname}} | data.extraSettings.displayname | The display name of the sender | No example yet |
{{avatar}} | data.extraSettings.avatar | The url of the avatar of the sender for a message | https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png |
{{platform}} | data.extraSettings.platform | The streaming platform this message is coming from | No example yet |
{{effect}} | data.extraSettings.effect | No description available yet. | Big Light |
{{effectId}} | data.extraSettings.effectId | No description available yet. | No example yet |
{{game}} | data.extraSettings.game | No description available yet. | Lumia Stream |
{{gameId}} | data.extraSettings.gameId | No description available yet. | No example yet |
{{artwork}} | data.extraSettings.artwork | No description available yet. | https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png |
{{message}} | data.extraSettings.message | The message text sent by the user | Turn on the lights |
{{duration}} | data.extraSettings.duration | No description available yet. | 5 |