Subscription

• Alert key: fourthwall-subscription
• Source: Fourthwall
• Event list label: Subscription

Default message template

{{username}} just subscribed

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
{{currency}}	data.extraSettings.currency	The currency used
{{amount}}	data.extraSettings.amount	The amount sent
{{interval}}	data.extraSettings.interval	The interval of the alert, such as monthly, yearly, etc.
{{id}}	data.extraSettings.id	No description available yet.
{{subscriptionType}}	data.extraSettings.subscriptionType	No description available yet.
{{tierId}}	data.extraSettings.tierId	No description available yet.
{{variantId}}	data.extraSettings.variantId	No description available yet.
{{createdAt}}	data.extraSettings.createdAt	No description available yet.
{{raw}}	data.extraSettings.raw	The raw data that comes in through the platform for the alert. This is useful for custom code when data is needed that we don't provide by default.

Example payloads

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

Subscribed

{
  "alert": "fourthwall-subscription",
  "dynamic": {
    "value": "Subscribed"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 100,
    "currency": "USD",
    "email": "",
    "interval": "",
    "id": "",
    "subscriptionType": "",
    "tierId": "",
    "variantId": "",
    "createdAt": "",
    "raw": ""
  }
}

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

Related

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