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 variable | Overlay payload field | Description |
|---|---|---|
{{username}} | data.extraSettings.username | The username of the sender |
{{email}} | data.extraSettings.email | Email of user |
{{message}} | data.extraSettings.message | The message text sent by the user |
{{currency}} | data.extraSettings.currency | The currency used |
{{amount}} | data.extraSettings.amount | The amount sent |
{{giveawayName}} | data.extraSettings.giveawayName | No description available yet. |
{{giveawayId}} | data.extraSettings.giveawayId | No description available yet. |
{{giveawayFriendlyId}} | data.extraSettings.giveawayFriendlyId | No description available yet. |
{{offerName}} | data.extraSettings.offerName | No description available yet. |
{{offerImageUrl}} | data.extraSettings.offerImageUrl | No description available yet. |
{{winners}} | data.extraSettings.winners | No description available yet. |
{{winnerNames}} | data.extraSettings.winnerNames | No description available yet. |
{{winnerCount}} | data.extraSettings.winnerCount | No description available yet. |
{{firstWinner}} | data.extraSettings.firstWinner | No description available yet. |
{{duration}} | data.extraSettings.duration | No description available yet. |
{{allGifts}} | data.extraSettings.allGifts | No description available yet. |
{{gifts}} | data.extraSettings.gifts | No description available yet. |
{{totalGifts}} | data.extraSettings.totalGifts | Gifts total count |
{{offer}} | data.extraSettings.offer | No description available yet. |
{{type}} | data.extraSettings.type | No 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:
RANDOMEQUAL_CURRENCY_NUMBER- Donation Amount is equal toGREATER_CURRENCY_NUMBER- Donation Amount is greater than or equal toEQUAL_VARIABLE
Related
- Alert Explorer - live preview of every alert
- Overlay Type Definitions - full
AlertEventTypeScript type