Skip to main content

Shop Purchase

  • Alert key: tiktok-shopPurchase
  • Source: TikTok
  • Event list label: Live Shopping

Default message template

Live Shopping: {{title}}

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
{{title}}data.extraSettings.titleThe title of the Twitch Redemption that was redeemed
{{price}}data.extraSettings.priceNo description available yet.
{{imageUrl}}data.extraSettings.imageUrlNo description available yet.
{{shopUrl}}data.extraSettings.shopUrlNo description available yet.
{{shopName}}data.extraSettings.shopNameNo description available yet.

Example payloads

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

Live Shopping

{
"alert": "tiktok-shopPurchase",
"dynamic": {
"value": "Featured Item"
},
"extraSettings": {
"title": "Featured Item",
"price": "$55.99",
"shopName": "Shopify",
"imageUrl": "",
"shopUrl": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_STRING - Title is equal to
  • EQUAL_VARIABLE