📜TSL Events & Predicates
What are possible events and their predicates?
TSL events are implemented following various streaming platforms' Socket API Documents. Every event served by those APIs is accesible by TSL. As the syntax rules require, events must come after ON
keyword, and predicates (if any) must be chained after WITH
word(s). Predicates cannot come before event declarations, the order is strict.
Currently supported platforms:
Streamlabs - Their API documentation
StreamElements - Their API documentation
Using invalid predicate properties will not cause any fatal error nor count as a syntax error. However, the rule might not work as expected.
(E.g using donation_amount >= 10
predicate with Twitch Follow
event might cause related action not to be performed)
While writing rules which has some intersecting predicates, their order shall be considered. Only the very first rule passing all the declared predicates will be performed. For example:
Event: Donation
When: Occurs when someone donates streamer. (Also refers to tips
on StreamElements)
Valid Predicates:
Event: JustGiving Donation
When: Occurs when someone donates using JustGiving integration. Valid Predicates:
Event: ExtraLife Donation
When: Occurs when someone donates using ExtraLife integration. Valid Predicates:
Event: Patreon Pledge
When: Occurs when someone pledges using Patreon integration. Valid Predicates:
Event: Tiltify Donation
When: Occurs when someone donates using Tiltify integration. Valid Predicates:
Event: TreatStream Treat
When: Occurs when someone treats using TreatStream integration. Valid Predicates:
Event: Loyalty Point Redemption
When: Occurs when someone redeems a Loyalty Point item. Valid Predicates:
Event: Twitch Channel Point Reward
When: Occurs when someone claims a Channel Points reward Valid Predicates:
Event: Twitch Chat Message
When: Occurs when someone sent a message on the chat. (See Chat page for more info) Valid Predicates:
Event: Twitch Follow
When: Occurs when someone follows streamer on Twitch. Valid Predicates:
Event: Twitch Subscription Gift
When: Occurs when someone gift some amount of subscription on Twitch. Valid Predicates:
Event: Twitch Subscription
When: Occurs when someone subscribes to streamer on Twitch. Valid Predicates:
Event: Twitch Host
When: Occurs when someone hosts streamer on Twitch. Valid Predicates:
Event: Twitch Raid
When: Occurs when someone raids streamer on Twitch. Valid Predicates:
Event: Twitch Bits
When: Occurs when someone donates streamer bits on Twitch. Valid Predicates:
Event: Youtube Subscription
Event: Youtube Sponsor
Event: Youtube Superchat
Event: Mixer Follow
Event: Mixer Subscription
Event: Mixer Host
Last updated