Charity Campaign Started

• Alert key: twitch-charityCampaignStarted
• Source: Twitch
• Event list label: Charity campaign start
• Carries alert image: yes (extraSettings.contentImage)

Default message template

Charity campaign {{charity_name}} started with a target of {{currencySymbol}}{{charity_target_amount}}

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
{{charity_name}}	data.extraSettings.charity_name	No description available yet.
{{charity_description}}	data.extraSettings.charity_description	No description available yet.
{{charity_logo}}	data.extraSettings.charity_logo	No description available yet.
{{charity_amount}}	data.extraSettings.charity_amount	No description available yet.
{{charity_target_amount}}	data.extraSettings.charity_target_amount	No description available yet.
{{charity_website}}	data.extraSettings.charity_website	No description available yet.
{{currency}}	data.extraSettings.currency	The currency used
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used
{{started_at}}	data.extraSettings.started_at	ISO String of the time this alert was triggered

Example payloads

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

Charity Started

{
  "alert": "twitch-charityCampaignStarted",
  "dynamic": {
    "value": "lumiastream"
  },
  "extraSettings": {
    "charity_id": "lumia123",
    "charity_name": "Lumia Charity",
    "charity_description": "Give me more lights",
    "contentImage": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "charity_amount": 0,
    "charity_target_amount": 100,
    "charity_website": "https://lumiastream.com",
    "currency": "USD",
    "started_at": "2022-07-26T17:00:03.17106713Z",
    "charity_logo": "",
    "currencySymbol": ""
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_VARIABLE

Related

• Alert Explorer - live preview of every alert
• Overlay Type Definitions - full AlertEvent TypeScript type