Skip to main content

Treasure Chest

  • Alert key: tiktok-treasureChest
  • Source: TikTok
  • Event list label: Treasure Chest

Default message template

{{username}} sent a treasure chest

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
{{userId}}data.extraSettings.userIdThe user ID of the sender
{{avatar}}data.extraSettings.avatarThe url of the avatar of the sender for a message
{{envelopeId}}data.extraSettings.envelopeIdNo description available yet.
{{diamondCount}}data.extraSettings.diamondCountNo description available yet.
{{peopleCount}}data.extraSettings.peopleCountNo description available yet.
{{unpackAt}}data.extraSettings.unpackAtNo description available yet.
{{amount}}data.extraSettings.amountThe amount sent

Example payloads

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

Treasure Chest

{
"alert": "tiktok-treasureChest",
"dynamic": {
"value": 50,
"name": "lumiastream",
"amount": 50
},
"extraSettings": {
"username": "lumiastream",
"diamondCount": 50,
"peopleCount": 5,
"amount": 50,
"userId": "",
"avatar": "",
"envelopeId": "",
"unpackAt": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

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