Triggers

Kick Triggers

Here you can find a list of all the events supported by this extension.

All events generated will have these default arguments set :

Argument	Type	Value
eventSource	string	Always set to kick for Kick events.
fromKick	bool	Always set to true for Kick events.

Channel

Follow

A user followed your channel.

Argument	Type	Always set	Value
user	string	Yes	Display name of the new follower.
userName	string	Yes	User slug of the new follower.
userId	string	Yes	User ID of the new follower.
userType	string	Yes	Always set to kick
isSubscribed	bool	Yes	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	Yes	Indicates whether the user is a moderator of the channel.
isVip	bool	Yes	Indicates whether the user is a VIP of the channel.

Chat

Chat Message

A chatter sent a message in your chatroom.

Argument	Type	Always set	Value
user	string	Yes	Display name of the user that sent this message.
userName	string	Yes	User slug of the user that sent this message.
userId	string	Yes	User ID of the user that sent this message.
userType	string	Yes	Always set to kick.
isSubscribed	bool	Yes	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	Yes	Indicates whether the user is a moderator of the channel.
isVip	bool	Yes	Indicates whether the user is a VIP of the channel.
msgId	string	Yes	Message ID.
chatroomId	long	Yes	Chatroom ID.
role	int	Yes	0 = Viewer, 1 = VIP, 2 = Mods, 3 = Broadcaster.
color	string	Yes	Hexadecimal color code.
message	string	Yes	Message content.
emoteCount	int	Yes	Number of emotes in the message.
emotes	string	Yes	Comma separated list of message's emotes.
messageStripped	string	Yes	Original message without any emotes.
messageCheermotesStripped	string	Yes	Original message without any emotes. Cheermotes doesn't exist on Kick yet.
isHighlight	bool	Yes	This feature is currently unsupported on Kick, so this will always be false.
bits	int	Yes	This feature is currently unsupported on Kick, so this will always be 0.
isAction	bool	Yes	This feature is currently unsupported on Kick, so this will always be false.
isReply	bool	Yes	Indicates whether this message is a reply or not.
reply.msgId	string	No	If isReply = true, this is the original message ID.
reply.message	string	No	If isReply = true, this is the original message content.
reply.userId	string	No	If isReply = true, this is the original sender ID.
reply.userName	string	No	If isReply = true, this is the original sender username.
firstMessage	bool	Yes	Indicates if this is the first message this user posted in your chat.
pinnableMessage	string	Yes	Serialized message to use when calling the PinMessage method.
isCommand	bool	Yes	Indicates whether this message is a command (matching an existing command) or not.

Pinned Message

A message is now pinned in chat.

Argument	Type	Always set	Value
user	string	Yes	Display name of the user that wrote the pinned message..
userName	string	Yes	User slug of the user that wrote the pinned message..
userId	string	Yes	User ID of the user that wrote the pinned message..
userType	string	Yes	Always set to kick.
isSubscribed	bool	Yes	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	Yes	Indicates whether the user is a moderator of the channel.
isVip	bool	Yes	Indicates whether the user is a VIP of the channel.
msgId	string	Yes	Message ID.
chatroomId	long	Yes	Chatroom ID.
role	int	Yes	0 = Viewer, 1 = VIP, 2 = Mods, 3 = Broadcaster.
color	string	Yes	Hexadecimal color code.
message	string	Yes	Message content.
emoteCount	int	Yes	Number of emotes in the message.
emotes	string	Yes	Comma separated list of message's emotes.
messageStripped	string	Yes	Original message without any emotes.
messageCheermotesStripped	string	Yes	Original message without any emotes. Cheermotes doesn't exist on Kick yet.
isHighlight	bool	Yes	This feature is currently unsupported on Kick, so this will always be false.
bits	int	Yes	This feature is currently unsupported on Kick, so this will always be 0.
isReply	bool	Yes	Indicates whether this message is a reply or not.

Unpinned Message

A pinned message has been unpinned. There are no argument set with this trigger.

Commands

Chat Command (Any)

A command was triggered from chat.

Argument	Type	Always set	Value
command	string	Yes	Command used.
commandId	string	Yes	Stream.bot internal command ID.
commandSource	string	Yes	Will always be set to kick for Kick commands.
commandType	string	Yes	Command type will always be message
rawInput	string	Yes	Additional data sent with the command.
rawInputEscaped	string	Yes	Additional data sent with the command.
rawInputUrlEncoded	string	Yes	Additional data sent with the command.
input#	string	Yes	Argument n°# passed to the command.
inputEscaped#	string	Yes	Argument n°# passed to the command.
inputUrlEncoded#	string	Yes	Argument n°# passed to the command.
user	string	Yes	Display name of the user that called this command.
userName	string	Yes	User slug of the user that called this command.
userId	string	Yes	User ID of the user that called this command.
userType	string	Yes	Always set to kick.
isSubscribed	bool	Yes	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	Yes	Indicates whether the user is a moderator of the channel.
isVip	bool	Yes	Indicates whether the user is a VIP of the channel.
msgId	string	Yes	Message ID.
chatroomId	long	Yes	Chatroom ID.
role	int	Yes	0 = Viewer, 1 = VIP, 2 = Mods, 3 = Broadcaster.
counter	int	Yes	Number of times this command have been executed.
userCounter	int	Yes	Number of times this particular user used this command.

Chat Command Cooldown (Any)

A command was triggered from chat by the command is on cooldown.

Argument	Type	Always set	Value
command	string	Yes	Command used.
commandId	string	Yes	Stream.bot internal command ID.
commandSource	string	Yes	Will always be set to kick for Kick commands.
commandType	string	Yes	Command type will always be message
user	string	Yes	Display name of the new follower.
userName	string	Yes	User slug of the new follower.
userId	string	Yes	User ID of the new follower.
userType	string	Yes	Always set to kick.
isSubscribed	bool	Yes	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	Yes	Indicates whether the user is a moderator of the channel.
isVip	bool	Yes	Indicates whether the user is a VIP of the channel.
cooldownLeft	long	Yes	Highest time left between globalCooldownLeft and userCooldownLeft.
globalCooldownLeft	long	Yes	Global time left before the command is usable again.
userCooldownLeft	long	Yes	Time left before the user can use this command again.

Moderation

Chat Message Deleted

A message has been deleted by a moderator/broadcaster.
If the deleted message has been sent recently, this trigger will set all the following arguments.
If more than 300 messages were sent in the meantime, the msgId will be the only argument set.

Argument	Type	Always set	Value
msgId	string	Yes	Message ID
user	string	No	Display name of the user that sent this message.
userName	string	No	User slug of the user that sent this message.
userId	string	No	User ID of the user that sent this message.
userType	string	No	Always set to kick.
isSubscribed	bool	No	Indicates whether the user is currently subscribed to the channel.
isModerator	bool	No	Indicates whether the user is a moderator of the channel.
isVip	bool	No	Indicates whether the user is a VIP of the channel.
chatroomId	long	No	Chatroom ID.
role	int	No	0 = Viewer, 1 = VIP, 2 = Mods, 3 = Broadcaster.
color	string	No	Hexadecimal color code.
message	string	No	Message content.

User TO

A user has been temporarily banned.

Argument	Type	Always set	Value
user	string	Yes	Display name of the banned user.
userName	string	Yes	User slug of the banned user.
userId	string	Yes	User ID of the banned user.
userType	string	Yes	Always set to kick.
duration	double	Yes	Ban duration in seconds.
createdAt	DateTime	Yes	Ban date.
createdById	long	Yes	ID of the moderator/broadcaster that banned the user.
createdByUsername	long	Yes	User slug of the moderator/broadcaster that banned the user.
createdByDisplayName	long	Yes	Display name of the moderator/broadcaster that banned the user.
reason	string	Yes	Ban reason. Can be an empty string if no reason was given.

User Banned

A user has been permanently banned.

Argument	Type	Always set	Value
user	string	Yes	Display name of the banned user.
userName	string	Yes	User slug of the banned user.
userId	string	Yes	User ID of the banned user.
userType	string	Yes	Always set to kick.
createdAt	DateTime	Yes	Ban date.
createdById	long	Yes	ID of the moderator/broadcaster that banned the user.
createdByUsername	long	Yes	User slug of the moderator/broadcaster that banned the user.
createdByDisplayName	long	Yes	Display name of the moderator/broadcaster that banned the user.
reason	string	Yes	Ban reason. Can be an empty string if no reason was given.

User Unbanned

A user has been unbanned.

Argument	Type	Always set	Value
user	string	Yes	Display name of the unbanned user.
userName	string	Yes	User slug of the unbanned user.
userId	string	Yes	User ID of the unbanned user.
userType	string	Yes	Always set to kick.
deletedById	long	Yes	ID of the moderator/broadcaster that unbanned the user.
deletedByUsername	long	Yes	User slug of the moderator/broadcaster that unbanned the user.
deletedByDisplayName	long	Yes	Display name of the moderator/broadcaster that unbanned the user.

Polls

Poll Created

A new poll started.

Argument	Type	Always set	Value
poll.StartedAt	DateTime	Yes	Poll starting date.
poll.Title	string	Yes	Poll title.
poll.Duration	long	Yes	Poll total duration.
poll.DurationRemaining	long	Yes	Poll remaining duration.
poll.choices.count	int	Yes	Choices count.
poll.choice#.title	string	Yes	Choice title.
poll.choice#.votes	int	Yes	Votes count for this choice.
poll.choice#.totalVotes	int	Yes	Votes count for this choice. (compatibility redundancy)
poll.votes	int	Yes	Total number of votes, all choices combined.
poll.totalVotes	int	Yes	Total number of votes, all choices combined. (compatibility redundancy)

Poll Updated

New votes have been registered.

Argument	Type	Always set	Value
poll.StartedAt	DateTime	Yes	Poll starting date.
poll.Title	string	Yes	Poll title.
poll.Duration	long	Yes	Poll total duration.
poll.DurationRemaining	long	Yes	Poll remaining duration.
poll.choices.count	int	Yes	Choices count.
poll.choice#.title	string	Yes	Choice title.
poll.choice#.votes	int	Yes	Votes count for this choice.
poll.choice#.totalVotes	int	Yes	Votes count for this choice. (compatibility redundancy)
poll.votes	int	Yes	Total number of votes, all choices combined.
poll.totalVotes	int	Yes	Total number of votes, all choices combined. (compatibility redundancy)

Poll Completed

A poll just ended.

Argument	Type	Always set	Value
poll.StartedAt	DateTime	Yes	Poll starting date.
poll.Title	string	Yes	Poll title.
poll.Duration	long	Yes	Poll total duration.
poll.DurationRemaining	long	Yes	Poll remaining duration.
poll.choices.count	int	Yes	Choices count.
poll.EndedAt	DateTime	Yes	Poll ending date.
poll.choice#.title	string	Yes	Choice title.
poll.choice#.votes	int	Yes	Votes count for this choice.
poll.choice#.totalVotes	int	Yes	Votes count for this choice. (compatibility redundancy)
poll.votes	int	Yes	Total number of votes, all choices combined.
poll.totalVotes	int	Yes	Total number of votes, all choices combined. (compatibility redundancy)
poll.winningIndex	int	Yes	Winning choice index.
poll.winningChoice.id	int	Yes	Winning choice ID (= index).
poll.winningChoice.title	string	Yes	Winning choice title.
poll.winningChoice.votes	int	Yes	Votes count for the winning choice.
poll.winningChoice.totalVotes	int	Yes	Votes count for the winning choice. (compatibility redundancy)

Poll Cancelled

A poll was canceled.

There is no particular argument set for this trigger.

Stream

Stream Started

A live broadcast started.

Argument	Type	Always set	Value
startedAt	DateTime	Yes	Starting date.
game	string	Yes	Category of the stream.
gameId	long	Yes	Category ID of the stream.
tagCount	int	Yes	Number of tags set.
tags	List	Yes	Tags list.
tagsDelimited	string	Yes	Tags list as a comma separated string.

Stream Ended

A live broadcast ended.

Argument	Type	Always set	Value
endedAt	DateTime	Yes	Starting date

Title/Category Changed

Stream title and/or category changed.

Argument	Type	Always set	Value
gameUpdate	bool	Yes	Category has changed.
statusUpdate	bool	Yes	Title has changed.
status	string	Yes	Current stream title.
oldStatus	string	Yes	If title changed, will be the old title. Will be the same as the current title otherwise.
gameId	long	Yes	Current category ID.
gameName	string	Yes	Current category name.
oldGameId	long	Yes	If category changed, will be the old category. Will be the same as the current category otherwise.
oldGameName	string	Yes	If category changed, will be the old category ID. Will be the same as the current category ID otherwise.

Subscriptions

Subscription

A new user subscribed to your channel.

Argument	Type	Always set	Value
user	string	Yes	Display name of the new sub.
userName	string	Yes	User slug of the new sub.
userId	string	Yes	User ID of the new sub.
userType	string	Yes	Always set to kick.
tier	string	Yes	On Kick, will always be Tier1
rawInput	string	Yes	Sample message linked to the sub (in French for now). This field is a bit useless and will be removed.
rawInputEscaped	string	Yes	Sample message linked to the sub (in French for now). This field is a bit useless and will be removed.

For recurring subs, these arguments will also be set :

Argument	Type	Always set	Value
monthStreak	long	No	Current sub streak.
cumulative	long	No	Total subscription duration (in months).

Sub Gifts (x1)

A user gifted a sub to someone.

Argument	Type	Always set	Value
user	string	Yes	Display name of the sub gifter.
userName	string	Yes	User slug of the sub gifter.
userId	string	Yes	User ID of the sub gifter.
userType	string	Yes	Always set to kick.
recipientUser	string	Yes	Display name of the gifted user.
recipientUserName	string	Yes	User slug of the gifted user.
recipientUserId	string	Yes	User ID of the gifted user.
tier	string	Yes	On Kick, will always be Tier1
totalSubsGifted	int	Yes	Number a gifts sent. Will be 1 for single gift.
monthsGifted	int	Yes	Number of months gifted. Kick doen't support multiple months gifts yet, so will be set to 1

Sub Gifts (Multiple)

A user gifted multiple subs at once.

Argument	Type	Always set	Value
user	string	Yes	Display name of the sub gifter.
userName	string	Yes	User slug of the sub gifter.
userId	string	Yes	User ID of the sub gifter.
userType	string	Yes	Always set to kick.
tier	string	Yes	On Kick, will always be Tier1
gifts	int	Yes	Number of subs gifted.
totalGifts	int	Yes	Number of subs gifted. Kick doesn't provide a cumulative gifts count for now, so it's the same value as gifts.

Raid

(Incoming) Raid

Another broadcaster raided your channel.

Argument	Type	Always set	Value
user	string	Yes	Display name of the broadcaster that raided your channel.
viewers	int	Yes	Number of users coming from the raid.