Skip to main content

Points

  • Alert key: kick-points
  • Source: Kick
  • Event list label: Redeemed

Default message template​

{{username}} redeemed {{command}} for {{amount}} points

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
{{userId}}data.extraSettings.userIdThe user ID of the sender
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{channelDescription}}data.extraSettings.channelDescriptionThe description of the target channel
{{channelViews}}data.extraSettings.channelViewsAmount of views the target channel has
{{originType}}data.extraSettings.originTypeNo description available yet.
{{queueType}}data.extraSettings.queueTypeNo description available yet.
{{command}}data.extraSettings.commandThe command that was triggered for the message
{{prompt}}data.extraSettings.promptThe users message that was prompted
{{message}}data.extraSettings.messageThe message text sent by the user
{{messageWithoutEmotes}}data.extraSettings.messageWithoutEmotesThe message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.
{{rawMessageWithoutEmotes}}data.extraSettings.rawMessageWithoutEmotesThe raw message that the sender sent without emotes inside of the message
{{points}}data.extraSettings.points(Twitch) How many points were used for a Twitch Point redemption
{{title}}data.extraSettings.titleThe title of the Twitch Redemption that was redeemed
{{timestamp}}data.extraSettings.timestampThe time the command was triggered

Example payloads​

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

Redeemed for 100 points​

{
  "alert": "kick-points",
  "dynamic": {
    "value": "100",
    "name": "lumiray",
    "currency": "points"
  },
  "extraSettings": {
    "command": "lumiray",
    "message": "ray ray",
    "username": "lumiastream",
    "displayname": "LumiaStream",
    "amount": "100",
    "currency": "points",
    "currencySymbol": "★",
    "userId": "",
    "avatar": "",
    "channelDescription": "",
    "channelViews": "",
    "originType": "",
    "queueType": "",
    "prompt": "",
    "messageWithoutEmotes": "",
    "rawMessageWithoutEmotes": "",
    "points": "",
    "title": "",
    "timestamp": ""
  }
}

Redeemed for 2000 points​

{
  "alert": "kick-points",
  "dynamic": {
    "value": "2000",
    "name": "lumiray",
    "currency": "points"
  },
  "extraSettings": {
    "command": "lumiray",
    "message": "ray ray",
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "displayname": "LumiaStream",
    "amount": "2000",
    "currency": "points",
    "currencySymbol": "★",
    "userId": "",
    "channelDescription": "",
    "channelViews": "",
    "originType": "",
    "queueType": "",
    "prompt": "",
    "messageWithoutEmotes": "",
    "rawMessageWithoutEmotes": "",
    "points": "",
    "title": "",
    "timestamp": ""
  }
}

Redeemed for 10000 points​

{
  "alert": "kick-points",
  "dynamic": {
    "value": "10000",
    "name": "lumiray",
    "currency": "points"
  },
  "extraSettings": {
    "command": "lumiray",
    "message": "ray ray",
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "displayname": "LumiaStream",
    "amount": "10000",
    "currency": "points",
    "currencySymbol": "★",
    "userId": "",
    "channelDescription": "",
    "channelViews": "",
    "originType": "",
    "queueType": "",
    "prompt": "",
    "messageWithoutEmotes": "",
    "rawMessageWithoutEmotes": "",
    "points": "",
    "title": "",
    "timestamp": ""
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Command is equal to
  • EQUAL_NUMBER - Amount is equal to
  • GREATER_NUMBER - Amount is greater than or equal to
  • EQUAL_VARIABLE