StreamElements triggers¶
Connected¶
Runs when Cuebot connects to StreamElements. 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 |
Type id: streamelements.connected
Disconnected¶
Runs when Cuebot loses or ends its connection to StreamElements. 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: streamelements.disconnected
Merch¶
Runs when someone buys from your StreamElements merch store. Handy to thank buyers on stream.
| Setting | What to put in |
|---|---|
| Minimum amount | The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0. |
| Maximum amount (0 = no limit) | The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0. |
| Currencies | Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency. |
| Include test events | Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who bought |
%product% |
What they bought (several items are joined with commas) |
%amount% |
The total price as a number |
%currency% |
The currency code, like USD |
%formattedAmount% |
The amount written nicely, like "$5.00" |
%merchQuantity% |
How many things they bought in total |
%message% |
Their message |
%isTest% |
True when this is a test event, not a real one |
Type id: streamelements.merch
Other relayed activity¶
Runs for any other activity StreamElements passes on, such as a hype train start. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
| Setting | What to put in |
|---|---|
| Activity type | Only run for this kind of activity, like "hypetrainStart". Leave empty for every other kind. |
Variables you get
| Variable | What it holds |
|---|---|
%activityType% |
The kind of activity |
%user% |
Who it was about, if anyone |
%amount% |
A number that came with it, if any |
%message% |
A message that came with it, if any |
Type id: streamelements.activity
Relayed charity donation¶
Runs when StreamElements passes on a gift to a charity campaign. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
| Setting | What to put in |
|---|---|
| Minimum amount | The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0. |
| Maximum amount (0 = no limit) | The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0. |
| Currencies | Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency. |
| Include test events | Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who gave |
%amount% |
The amount as a number, like 5 or 12.5 |
%currency% |
The currency code, like USD |
%formattedAmount% |
The amount written nicely, like "$5.00" |
%message% |
Their message |
Type id: streamelements.charityDonation
Relayed cheer¶
Runs when StreamElements passes on someone cheering bits. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
| Setting | What to put in |
|---|---|
| Minimum bits | Only run when at least this many bits were cheered. Leave 0 for any amount. Starts as: 0. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who cheered |
%bits% |
How many bits |
%message% |
Their message |
Type id: streamelements.cheer
Relayed community gift¶
Runs when StreamElements passes on someone gifting subs to the community. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who gave the gifts |
%gift% |
How many subs were gifted |
%tier% |
The sub level |
Type id: streamelements.communityGift
Relayed follow¶
Runs when StreamElements passes on a new follower. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
Variables you get
| Variable | What it holds |
|---|---|
%user% |
The new follower |
%platform% |
Where they followed |
Type id: streamelements.follow
Relayed host¶
Runs when StreamElements passes on another streamer hosting you. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who is hosting you |
%viewers% |
How many viewers they brought |
Type id: streamelements.host
Relayed raid¶
Runs when StreamElements passes on a raid. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
| Setting | What to put in |
|---|---|
| Minimum viewers | Only run when at least this many viewers came along. Leave 0 for any number. Starts as: 0. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who raided you |
%viewers% |
How many viewers they brought |
Type id: streamelements.raid
Relayed subscriber¶
Runs when StreamElements passes on a new or returning subscriber. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who subscribed |
%months% |
How many months |
%tier% |
The sub level |
%isGift% |
True if someone paid for it as a gift |
%gifter% |
Who paid for it |
%message% |
Their message |
Type id: streamelements.subscriber
Relayed Super Chat¶
Runs when StreamElements passes on a YouTube Super Chat. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
| Setting | What to put in |
|---|---|
| Minimum amount | The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0. |
| Maximum amount (0 = no limit) | The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0. |
| Currencies | Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency. |
| Include test events | Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who sent it |
%amount% |
The amount as a number, like 5 or 12.5 |
%currency% |
The currency code, like USD |
%formattedAmount% |
The amount written nicely, like "$5.00" |
%message% |
Their comment |
Type id: streamelements.superchat
Relayed YouTube membership¶
Runs when StreamElements passes on a new YouTube channel member. Only runs if you tick the "Also publish..." box for StreamElements on the Donations page (off by default, because your streaming site already reports it).
Variables you get
| Variable | What it holds |
|---|---|
%user% |
The new member |
%months% |
How many months |
%tier% |
Their membership level |
Type id: streamelements.sponsor
Store redemption¶
Runs when a viewer spends loyalty points on an item in your StreamElements store.
| Setting | What to put in |
|---|---|
| Item name | Only run for this store item, typed as it is named in your store, like "Hydrate!". Leave empty for any item. |
| Include test events | Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who bought it |
%item% |
The item they picked |
%cost% |
How many points it cost |
%message% |
Their message |
%isTest% |
True when this is a test event, not a real one |
Type id: streamelements.redemption
Tip¶
Runs when someone tips you through StreamElements. Great for a thank-you message or an alert.
| Setting | What to put in |
|---|---|
| Minimum amount | The smallest amount that runs this. Example: 5 ignores anything under 5. Leave 0 to run for any amount. Amounts are not converted between currencies. Starts as: 0. |
| Maximum amount (0 = no limit) | The biggest amount that runs this. Leave 0 for no upper limit. Starts as: 0. |
| Currencies | Only run for these currencies. Type the short codes with commas, like "USD, EUR". Leave empty for every currency. |
| Include test events | Tick to also run for test events (made with a "send test" button). Untick to run only for real ones. Starts as: true. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Who tipped |
%amount% |
The amount as a number, like 5 or 12.5 |
%currency% |
The currency code, like USD |
%formattedAmount% |
The amount written nicely, like "$5.00" |
%message% |
The message they wrote |
%avatar% |
Their picture (web link) |
%tipId% |
The number StreamElements gave this tip |
%isTest% |
True when this is a test event, not a real one |
Type id: streamelements.tip