Skip to main content

Timeout

  • Alert key: twitch-timeout
  • Source: Twitch
  • Event list label: Timeout

Default message template

{{username}} is timed out

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
{{userId}}data.extraSettings.userIdThe user ID of the sender
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{timeout_duration}}data.extraSettings.timeout_durationTimeout duration in seconds
{{expiration_ms}}data.extraSettings.expiration_msNo description available yet.
{{reason}}data.extraSettings.reasonBan 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) => …).

Timed Out

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

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_USERNAME
  • EQUAL_VARIABLE