4.3 KiB
Available Events
bits
User spent bits in the channel. The full message is available like in a normal chat message, additionally the {{ .bits }} field is added with the total amount of bits spent.
Fields:
bits- Total amount of bits spent in the messagechannel- The channel the event occurred inusername- The login-name of the user who spent the bits
category_update
The current category for the channel was changed. (This event has some delay to the real category change!)
Fields:
category- The name of the new game / categorychannel- The channel the event occurred in
join
User joined the channel-chat. This is NOT an indicator they are viewing, the event is NOT reliably sent when the user really joined the chat. The event will be sent with some delay after they join the chat and is sometimes repeated multiple times during their stay. So DO NOT use this to greet users!
Fields:
channel- The channel the event occurred inusername- The login-name of the user who joined
part
User left the channel-chat. This is NOT an indicator they are no longer viewing, the event is NOT reliably sent when the user really leaves the chat. The event will be sent with some delay after they leave the chat and is sometimes repeated multiple times during their stay. So this does NOT mean they do no longer read the chat!
Fields:
channel- The channel the event occurred inusername- The login-name of the user who left
permit
User received a permit, which means they are no longer affected by rules which are disabled on permit.
Fields:
channel- The channel the event occurred inusername- The login-name of the user
raid
The channel was raided by another user.
Fields:
channel- The channel the event occurred inusername- The login-name of the user who raided the channelviewercount- The amount of users who have been raided (this number is not fully accurate)
resub
The user shared their resubscription. (This event is triggered manually by the user using the "Share my Resub" button and does not occur when the user does not actively share their sub!)
Fields:
channel- The channel the event occurred inplan- The sub-plan they are using (1000= T1,2000= T2,3000= T3,Prime)subscribed_months- How long have they been subscribedusername- The login-name of the user who resubscribed
stream_offline
The channels stream went offline. (This event has some delay to the real category change!)
Fields:
channel- The channel the event occurred in
stream_online
The channels stream went offline. (This event has some delay to the real category change!)
Fields:
channel- The channel the event occurred in
sub
The user newly subscribed on their own. (This event is triggered automatically and does not need to be shared actively!)
Fields:
channel- The channel the event occurred inplan- The sub-plan they are using (1000= T1,2000= T2,3000= T3,Prime)username- The login-name of the user who subscribed
subgift
The user gifted the subscription to a specific user. (This event DOES occur multiple times after submysterygift events!)
Fields:
channel- The channel the event occurred ingifted_months- Number of months the user giftedplan- The sub-plan they are using (1000= T1,2000= T2,3000= T3,Prime)to- The user who received the subusername- The login-name of the user who gifted the subscription
submysterygift
The user gifted multiple subs to the community. (This event is followed by number x subgift events.)
Fields:
channel- The channel the event occurred innumber- The amount of gifted subsplan- The sub-plan they are using (1000= T1,2000= T2,3000= T3,Prime)username- The login-name of the user who gifted the subscription
title_update
The current title for the channel was changed. (This event has some delay to the real category change!)
Fields:
channel- The channel the event occurred intitle- The title of the stream
whisper
The bot received a whisper message. (You can use (.*) as message match and {{ group 1 }} as template to get the content of the whisper.)
Fields:
username- The login-name of the user who sent the message