Repository navigation
Reference Triggers Hyperate
Also on the Cuebot Docs site.
Runs when Cuebot connects to HypeRate. Handy for a quick "all good" message or to switch something on.
Variables you get
| Variable | What it holds |
|---|---|
%service% |
The name of the service |
%sessionId% |
The HypeRate ID you are watching |
Type id: hyperate.connected
Runs when Cuebot loses or ends its connection to HypeRate. Handy to warn yourself that alerts have stopped.
Variables you get
| Variable | What it holds |
|---|---|
%service% |
The name of the service |
%reason% |
Why the connection ended |
Type id: hyperate.disconnected
Runs for every new heart rate reading from HypeRate. It can run about once a second, so keep the action short.
Variables you get
| Variable | What it holds |
|---|---|
%heartRate% |
Heart rate right now, in beats per minute |
%previousHeartRate% |
The heart rate before this one |
%source% |
Where it came from: Pulsoid or HypeRate |
Type id: hyperate.heartRate
Runs once when your HypeRate heart rate reaches a number you pick or goes higher. Fun for a "calm down!" moment.
| Setting | What to put in |
|---|---|
| Threshold (BPM) | The heart rate to watch for, in beats per minute. It runs when you reach this number or higher. Starts as: 120. |
| Reset distance (BPM) | How far your heart rate must fall below the threshold before this can run again. Stops it firing over and over when you hover near the number. Starts as: 5. |
Variables you get
| Variable | What it holds |
|---|---|
%heartRate% |
Heart rate right now, in beats per minute |
%previousHeartRate% |
The heart rate before this one |
%source% |
Where it came from: Pulsoid or HypeRate |
%heartRateThreshold% |
The threshold you set |
Type id: hyperate.heartRateAbove
Runs once when your HypeRate heart rate drops to a number you pick or lower. Fun for a "are you still alive?" moment.
| Setting | What to put in |
|---|---|
| Threshold (BPM) | The heart rate to watch for, in beats per minute. It runs when you reach this number or lower. Starts as: 60. |
| Reset distance (BPM) | How far your heart rate must rise above the threshold before this can run again. Stops it firing over and over when you hover near the number. Starts as: 5. |
Variables you get
| Variable | What it holds |
|---|---|
%heartRate% |
Heart rate right now, in beats per minute |
%previousHeartRate% |
The heart rate before this one |
%source% |
Where it came from: Pulsoid or HypeRate |
%heartRateThreshold% |
The threshold you set |
Type id: hyperate.heartRateBelow
Runs when your HypeRate heart rate changes enough. Good for updating a number on screen without running every second.
| Setting | What to put in |
|---|---|
| Minimum seconds between runs | The least number of seconds to wait between runs. 5 means at most one run every five seconds. Starts as: 5. |
| Minimum change (BPM) | Only run when your heart rate moved at least this many beats per minute since the last run. Starts as: 1. |
Variables you get
| Variable | What it holds |
|---|---|
%heartRate% |
Heart rate right now, in beats per minute |
%previousHeartRate% |
The heart rate before this one |
%source% |
Where it came from: Pulsoid or HypeRate |
%lastTriggeredHeartRate% |
The heart rate at the last run |
%heartRateChange% |
How much it changed since then (minus means it fell) |
Type id: hyperate.heartRateChanged
Runs when a Twitch clip is made through HypeRate. Handy to share the clip link in chat.
Variables you get
| Variable | What it holds |
|---|---|
%clipUrl% |
The web link to the clip |
%twitchSlug% |
The clip's short name |
Type id: hyperate.clipCreated