Hype Train Begin
Runs on: Shared — pure logic, runs on the Streamerly backend or inside a chatbox overlay.
The Hype Train Begin trigger fires the moment a hype train kicks off in your channel. Twitch starts a hype train when your community rapidly chains together subscriptions, cheers, and similar contributions. This trigger gives you the Goal — the total points needed to reach Level 1 — so you can communicate the target to your audience or set up a countdown.
Use this trigger to announce the hype train in chat, activate a special hype train overlay, or play a sound effect that gets the energy going. Pair it with the Hype Train Level Up and Hype Train End triggers for a complete hype train experience.
Outputs
| Name | Type | Description |
|---|---|---|
Goal | number | The number of points required to reach Level 1 of the hype train. |
Level | number | The starting level of the hype train. |
Total | number | The cumulative points contributed so far. |
Progress | number | The points contributed toward the current level. |
ExpiresAt | string | ISO timestamp for when the current level's countdown expires. |
AllTimeHighLevel | number | The highest level your channel has ever reached in a hype train. |
AllTimeHighTotal | number | The most points your channel has ever contributed to a single hype train. |
Type | string | The kind of train: regular, golden_kappa, or treasure. |
StartedAt | string | ISO timestamp for when the hype train started. |
TopBitsUser | string | Display name of the top Bits contributor. |
TopBitsTotal | number | Points contributed by the top Bits contributor. |
TopSubsUser | string | Display name of the top subscriptions contributor. |
TopSubsTotal | number | Points contributed by the top subscriptions contributor. |
Type replaces the old Golden Kappa flag. To react only to a Golden Kappa train, branch on Type equalling golden_kappa (a Treasure Train reports treasure, and an ordinary train reports regular).
Example
When a hype train begins, fire a chat message such as "A hype train has started! We need [Goal] points to hit Level 1 — let's go!" Connect the Goal output to a String Op node to insert the actual number into the message. Branch on the Type output to give Golden Kappa and Treasure Trains their own announcement, and use AllTimeHighTotal to call out when the channel is closing in on a record.