Skip to main content

Giveaway Ended

  • Alert key: fourthwall-giveawayEnded
  • Source: Fourthwall
  • Event list label: Giveaway Ended
  • Carries alert image: yes (extraSettings.contentImage)

Default message template

Giveaway {{giveawayName}} ended with {{winnerCount}} winners

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
{{email}}data.extraSettings.emailEmail of user
{{message}}data.extraSettings.messageThe message text sent by the user
{{currency}}data.extraSettings.currencyThe currency used
{{amount}}data.extraSettings.amountThe amount sent
{{giveawayName}}data.extraSettings.giveawayNameNo description available yet.
{{giveawayId}}data.extraSettings.giveawayIdNo description available yet.
{{giveawayFriendlyId}}data.extraSettings.giveawayFriendlyIdNo description available yet.
{{offerName}}data.extraSettings.offerNameNo description available yet.
{{offerImageUrl}}data.extraSettings.offerImageUrlNo description available yet.
{{winners}}data.extraSettings.winnersNo description available yet.
{{winnerNames}}data.extraSettings.winnerNamesNo description available yet.
{{winnerCount}}data.extraSettings.winnerCountNo description available yet.
{{firstWinner}}data.extraSettings.firstWinnerNo description available yet.
{{duration}}data.extraSettings.durationNo description available yet.
{{allGifts}}data.extraSettings.allGiftsNo description available yet.
{{gifts}}data.extraSettings.giftsNo description available yet.
{{totalGifts}}data.extraSettings.totalGiftsGifts total count
{{offer}}data.extraSettings.offerNo description available yet.
{{type}}data.extraSettings.typeNo description available yet.

Example payloads

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

Test

{
"alert": "fourthwall-giveawayEnded",
"dynamic": {
"value": 3,
"currency": "USD"
},
"extraSettings": {
"giveawayName": "Test Item",
"giveawayId": "TEST123",
"winners": [
"winner1",
"winner2",
"winner3"
],
"winnerCount": 3,
"contentImage": "https://cdn.fourthwall.com/storefront-en/_next/image?url=https%3A%2F%2Fcdn.fourthwall.com%2Fpublic%2Flogos%2Ffw-logo-stacked-purple.png",
"username": "",
"email": "",
"message": "",
"currency": "",
"amount": "",
"giveawayFriendlyId": "",
"offerName": "",
"offerImageUrl": "",
"winnerNames": "",
"firstWinner": "",
"duration": "",
"allGifts": "",
"gifts": "",
"totalGifts": "",
"offer": "",
"type": ""
}
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

  • RANDOM
  • EQUAL_CURRENCY_NUMBER - Donation Amount is equal to
  • GREATER_CURRENCY_NUMBER - Donation Amount is greater than or equal to
  • EQUAL_VARIABLE