Streamlabs triggers¶
Charity donation¶
Runs when someone gives to a charity campaign you run on Streamlabs. Good for a special thank-you.
| 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% |
The message they wrote |
%charityName% |
The name of the charity |
%campaignId% |
The campaign this gift belongs to |
%isTest% |
True when this is a test event, not a real one |
Type id: streamlabs.charityDonation
Connected¶
Runs when Cuebot connects to Streamlabs. 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: streamlabs.connected
Disconnected¶
Runs when Cuebot loses or ends its connection to Streamlabs. 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: streamlabs.disconnected
Donation¶
Runs when someone donates through Streamlabs. 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 donated ("Anonymous" if unknown) |
%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 the donor wrote |
%donationId% |
The number Streamlabs gave this donation |
%isTest% |
True when this is a test event, not a real one |
Type id: streamlabs.donation
Loyalty store redemption¶
Runs when a viewer spends points on an item in your Streamlabs Cloudbot loyalty store.
| Setting | What to put in |
|---|---|
| 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 |
%product% |
The item they picked |
%message% |
Their message |
%isTest% |
True when this is a test event, not a real one |
Type id: streamlabs.loyaltyStoreRedemption
Merchandise¶
Runs when someone buys something from your Streamlabs merch store. Handy to thank buyers on stream.
| Setting | What to put in |
|---|---|
| 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 |
%product% |
What they bought |
%message% |
Their message |
%imageUrl% |
A picture of the product (web link) |
%isTest% |
True when this is a test event, not a real one |
Type id: streamlabs.merch
Prime gift¶
Runs when someone gives away a Twitch Prime sub through Streamlabs. Nice for a shout-out.
| Setting | What to put in |
|---|---|
| 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 the gift |
%recipient% |
Who got it |
%gift% |
What kind of gift it was |
%streamer% |
Which streamer it was for |
%isTest% |
True when this is a test event, not a real one |
Type id: streamlabs.primeSubGift
Relayed bits¶
Runs when Streamlabs passes on someone cheering bits. Only runs if you tick the "Also publish..." box for Streamlabs 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: streamlabs.bits
Relayed follow¶
Runs when Streamlabs passes on a new follower. Only runs if you tick the "Also publish..." box for Streamlabs 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, like Twitch or YouTube |
Type id: streamlabs.follow
Relayed host¶
Runs when Streamlabs passes on another streamer hosting you. Only runs if you tick the "Also publish..." box for Streamlabs 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: streamlabs.host
Relayed raid¶
Runs when Streamlabs passes on a raid. Only runs if you tick the "Also publish..." box for Streamlabs 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: streamlabs.raid
Relayed subscription¶
Runs when Streamlabs passes on a new or returning subscriber. Only runs if you tick the "Also publish..." box for Streamlabs 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 in a row |
%tier% |
The sub level |
%message% |
Their message |
%gifter% |
Who paid for it, if it was a gift |
%platform% |
Where they subscribed |
Type id: streamlabs.subscription
Relayed Super Chat¶
Runs when Streamlabs passes on a YouTube Super Chat. Only runs if you tick the "Also publish..." box for Streamlabs 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: streamlabs.superchat