Skip to main content

Subscriber

  • Alert key: youtube-subscriber
  • Source: YouTube
  • Event list label: Subscribed

Default message template

{{username}} just subscribed!

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
{{displayname}}data.extraSettings.displaynameThe display name of the sender
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{userId}}data.extraSettings.userIdThe user ID of the sender

Example payloads

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

Lumia subscribed

{
"alert": "youtube-subscriber",
"dynamic": {
"value": "lumiastream"
},
"extraSettings": {
"username": "lumiastream",
"displayname": "LumiaStream",
"avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
"userId": "1234"
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_USERNAME
  • EQUAL_VARIABLE