Skip to main content

Host

  • Alert key: kick-host
  • Source: Kick
  • Event list label: Hosted

Default message template

{{username}} hosted with {{viewers}} viewers

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
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{viewers}}data.extraSettings.viewersViewers count
{{amount}}data.extraSettings.amountThe amount sent

Example payloads

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

10 viewers

{
"alert": "kick-host",
"dynamic": {
"value": 10,
"amount": 10
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"viewers": 10,
"amount": 10
}
}

50 viewers

{
"alert": "kick-host",
"dynamic": {
"value": 50,
"amount": 50
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"viewers": 50,
"amount": 50
}
}

100 viewers

{
"alert": "kick-host",
"dynamic": {
"value": 100,
"amount": 100
},
"extraSettings": {
"username": "lumiastream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"viewers": 100,
"amount": 100
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • GREATER_NUMBER - Viewers is greater than or equal to
  • EQUAL_VARIABLE