Skip to main content

Subscriber

  • Alert key: twitch-subscriber
  • Source: Twitch
  • Event list label: {{tier}} Sub

Default message template​

{{username}} just subscribed with a {{tier}} sub!

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
{{tier}}data.extraSettings.tierTier gift
{{recipient}}data.extraSettings.recipientUser being gifted the sub
{{subMonths}}data.extraSettings.subMonthsHow many months the user has been subbed for
{{streakMonths}}data.extraSettings.streakMonthsHow many months the user has been subbed for in a row
{{message}}data.extraSettings.messageThe message text sent by the user
{{subPlan}}data.extraSettings.subPlanSubs plan value (1000, 2000, 3000)
{{subPlanName}}data.extraSettings.subPlanNameSubs plan value name (Tier 1, Tier 2, Tier 3)

Example payloads​

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

Tier 1 Sub​

{
  "alert": "twitch-subscriber",
  "dynamic": {
    "value": 1000
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "message": "Great Stream",
    "subMonths": 1,
    "streakMonths": 1,
    "tier": "Tier 1",
    "subPlan": 1000,
    "subPlanName": "My Day ones",
    "recipient": ""
  }
}

Tier 2 Sub​

{
  "alert": "twitch-subscriber",
  "dynamic": {
    "value": 2000
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "message": "Great Stream",
    "subMonths": 2,
    "streakMonths": 2,
    "tier": "Tier 2",
    "subPlan": 2000,
    "subPlanName": "My Day dos",
    "recipient": ""
  }
}

Tier 3 Sub​

{
  "alert": "twitch-subscriber",
  "dynamic": {
    "value": 3000
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "message": "Great Stream",
    "subMonths": 3,
    "streakMonths": 3,
    "tier": "Tier 3",
    "subPlan": 3000,
    "subPlanName": "My Day tres",
    "recipient": ""
  }
}

Prime Sub​

{
  "alert": "twitch-subscriber",
  "dynamic": {
    "value": "Prime"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "message": "Great Stream",
    "subMonths": 1,
    "streakMonths": 1,
    "tier": "Prime",
    "subPlan": "Prime",
    "subPlanName": "Optimus Prime",
    "recipient": ""
  }
}

Resubscribed 3 months​

{
  "alert": "twitch-subscriber",
  "dynamic": {
    "value": 1000,
    "subMonths": 3
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "message": "Great Stream",
    "subMonths": 3,
    "streakMonths": 3,
    "tier": "Tier 1",
    "subPlan": 1000,
    "subPlanName": "My Day ones",
    "recipient": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_SELECTION - Sub Tier is equal to
  • SUBSCRIBED_MONTHS_EQUAL - Months Subscribed is equal to
  • SUBSCRIBED_MONTHS_GREATER - Months Subscribed is greater than or equal to
  • IS_PRIME - Is a Prime sub
  • EQUAL_USERNAME
  • EQUAL_VARIABLE