Shoutout Receive

• Alert key: twitch-shoutoutReceive
• Source: Twitch
• Event list label: Shoutout

Default message template

{{username}} sent you a shoutout

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
{{userId}}	data.extraSettings.userId	The user ID of the sender
{{displayname}}	data.extraSettings.displayname	The display name of the sender
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message
{{viewer_count}}	data.extraSettings.viewer_count	No description available yet.
{{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) => …).

Shoutout Receive

{
  "alert": "twitch-shoutoutReceive",
  "dynamic": {
    "value": "lumiastream"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "displayname": "LumiaStream",
    "userId": "1234",
    "viewer_count": 100,
    "started_at": "2022-07-26T17:00:03.17106713Z"
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_STRING - Username is equal to
• EQUAL_VARIABLE

Related

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