Skip to main content

Gift Subscription

  • Alert key: twitch-giftSubscription
  • Source: Twitch
  • Event list label: Gifted {{giftAmount}} subs

Default message template​

{{gifter}} gifted {{giftAmount}} {{tier}} subs to {{recipients}}

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
{{giftAmount}}data.extraSettings.giftAmountAmount gifted by user
{{amount}}data.extraSettings.amountThe amount sent
{{recipients}}data.extraSettings.recipientsUsers being gifted the gift subscription. Comma separated list of usernames
{{recipientsRaw}}data.extraSettings.recipientsRawUsers being gifted the gift subscription. Raw array of usernames, avatar, and userId. mainly used for custom code and custom overlays. Can be accessed with dot notation e.g. {{recipientsRaw.0.avatar}} to get the first users avatar
{{gifter}}data.extraSettings.gifterThe username of the one who gifted
{{totalGifts}}data.extraSettings.totalGiftsGifts total count
{{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) => …).

Gift 1 Sub​

{
  "alert": "twitch-giftSubscription",
  "dynamic": {
    "value": 1000,
    "giftAmount": 1,
    "amount": 1
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "gifter": "lumiastream",
    "message": "Great Stream",
    "recipients": "worldlights",
    "recipientsRaw": [
      {
        "username": "worldlights",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      }
    ],
    "giftAmount": 1,
    "amount": 1,
    "totalGifts": 1,
    "subMonths": 1,
    "tier": "Tier 1",
    "subPlan": 1000,
    "subPlanName": "My Day ones",
    "streakMonths": ""
  }
}

Gift 5 Subs​

{
  "alert": "twitch-giftSubscription",
  "dynamic": {
    "value": 1000,
    "giftAmount": 5,
    "amount": 5
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "gifter": "lumiastream",
    "message": "Great Stream",
    "recipients": "worldlights,lumiastream,lumiatwitch,lumiakick,rgblumia",
    "recipientsRaw": [
      {
        "username": "worldlights",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      },
      {
        "username": "lumiastream",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      },
      {
        "username": "lumiatwitch",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      },
      {
        "username": "worldlights",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      },
      {
        "username": "rgblumia",
        "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures",
        "userId": "123",
        "userLevels": {
          "subscriber": true
        }
      }
    ],
    "giftAmount": 5,
    "amount": 5,
    "totalGifts": 5,
    "subMonths": 1,
    "tier": "Tier 1",
    "subPlan": 1000,
    "subPlanName": "My Day unos",
    "streakMonths": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_SELECTION - Sub Tier is equal to
  • GIFT_SUB_EQUAL - Gift Sub Amount is equal to
  • GIFT_SUB_GREATER - Gift Sub Amount is greater than or equal to
  • EQUAL_USERNAME
  • EQUAL_VARIABLE