Skip to main content

Session Kicks

  • Alert key: kick-sessionKicks
  • Source: Kick
  • Event list label: Total Kicks {{total}}

Default message template​

Reached {{total}} kicks

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 variableOverlay payload fieldDescription
{{total}}data.extraSettings.totalHype train current total
{{previousTotal}}data.extraSettings.previousTotalNo description available yet.

Example payloads​

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

1000 Total Kicks​

{
  "alert": "kick-sessionKicks",
  "dynamic": {
    "value": 1000,
    "total": 1000,
    "previousTotal": 500
  },
  "extraSettings": {
    "total": 1000,
    "previousTotal": 500
  }
}

20000 Total Kicks​

{
  "alert": "kick-sessionKicks",
  "dynamic": {
    "value": 20000,
    "total": 20000,
    "previousTotal": 10000
  },
  "extraSettings": {
    "total": 20000,
    "previousTotal": 10000
  }
}

100000 Total Kicks​

{
  "alert": "kick-sessionKicks",
  "dynamic": {
    "value": 100000,
    "total": 100000,
    "previousTotal": 50000
  },
  "extraSettings": {
    "total": 100000,
    "previousTotal": 50000
  }
}

Variation conditions​

Dimensions you can branch on when configuring alert variations:

  • GREATER_NUMBER - Total Session Kicks is greater than or equal to
  • COUNT_IS_MULTIPLE_OF - Total Session Kicks Count is a multiple of