Kicks

• Alert key: kick-kicks
• Source: Kick
• Event list label: Kicks
• Carries alert image: yes (extraSettings.contentImage)

Default message template

{{username}} sent {{name}} for {{amount}} kicks. They said "{{message}}"

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
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message
{{amount}}	data.extraSettings.amount	The amount sent
{{name}}	data.extraSettings.name	Name of user
{{type}}	data.extraSettings.type	No description available yet.
{{tier}}	data.extraSettings.tier	Tier gift
{{id}}	data.extraSettings.id	No description available yet.
{{message}}	data.extraSettings.message	The message text sent by the user

Example payloads

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

100 kicks Hype

{
  "alert": "kick-kicks",
  "dynamic": {
    "value": 100,
    "name": "Hype"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 100,
    "name": "Hype",
    "type": "BASIC",
    "tier": "BASIC",
    "id": "hype",
    "message": "This is so hype",
    "contentImage": "https://files.kick.com/kicks/gifts/hype.webp"
  }
}

500 kicks Rage Quit

{
  "alert": "kick-kicks",
  "dynamic": {
    "value": 500,
    "name": "Rage Quit"
  },
  "extraSettings": {
    "username": "lumiastream",
    "avatar": "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png",
    "amount": 500,
    "name": "Rage Quit",
    "type": "LEVEL_UP",
    "tier": "MID",
    "id": "rage_quit",
    "message": "Im raging!!",
    "contentImage": "https://files.kick.com/kicks/gifts/rage-quit.webp"
  }
}

Variation conditions

Dimensions you can branch on when configuring alert variations:

• RANDOM
• EQUAL_SELECTION - Kicks Name is equal to
• EQUAL_NUMBER - Kicks Amount is equal to
• GREATER_NUMBER - Kicks Amount is greater than or equal to
• EQUAL_VARIABLE

Related

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