Skip to main content

Retweet

  • Alert key: twitter-retweet
  • Source: Twitter
  • Event list label: Retweet

Default message template​

{{username}} retweeted

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
{{retweets}}data.extraSettings.retweetsRetweets count
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{username}}data.extraSettings.usernameThe username of the sender
{{userId}}data.extraSettings.userIdThe user ID of the sender
{{displayname}}data.extraSettings.displaynameThe display name of the sender
{{banner}}data.extraSettings.bannerNo description available yet.
{{profile_background_color}}data.extraSettings.profile_background_colorNo description available yet.
{{profile_link_color}}data.extraSettings.profile_link_colorNo description available yet.
{{user_followers}}data.extraSettings.user_followersNo description available yet.
{{user_likes}}data.extraSettings.user_likesNo description available yet.
{{is_following}}data.extraSettings.is_followingNo description available yet.
{{following_count}}data.extraSettings.following_countNo description available yet.
{{verified}}data.extraSettings.verifiedNo description available yet.
{{private}}data.extraSettings.privateNo description available yet.

Example payloads​

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

New Retweet​

{
  "alert": "twitter-retweet",
  "dynamic": {
    "value": "lumiastream"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "retweets": 100,
    "userId": "",
    "displayname": "",
    "banner": "",
    "profile_background_color": "",
    "profile_link_color": "",
    "user_followers": "",
    "user_likes": "",
    "is_following": "",
    "following_count": "",
    "verified": "",
    "private": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_NUMBER - Retweet Count is equal to
  • GREATER_NUMBER - Retweet Count is greater than or equal to
  • EQUAL_USERNAME
  • EQUAL_VARIABLE