Command Triggered

Preview

Check out the Commands Guide for details on configuring your Commands

Parameters

Commands

Select

Select a command from the Commands tab.

You can quickly register a new command by clicking the Create Command button!

The following variables will be populated when this trigger executes:

		Description
`command`	`string`	The command that was used Example: `!shoutout`
`commandId`	`Guid`	The ID of the command
`commandSource`	`string`	The command source Example: `twitch`
`commandType`	`string`	The type of the command Example: `message`
`counter`	`number`	A running total of how many times a command has been run since application launch Example: `17`
`input#`	`string`	The `#` word of the message entered, spaces are delimiters and variable names are 0 indexed, so `input0` would give the first word, `input1` would give the second, and so on
`inputEscaped#`	`string`	The indexed word escaped
`inputUrlEncoded#`	`string`	The indexed word URL encoded
`msgId`	`string`	The unique message id for this message
`rawInput`	`string`	The message entered, if the command was a Starts With, this will be removed
`rawInputEscaped`	`string`	The message escaped
`rawInputUrlEncoded`	`string`	The message URL encoded
`role`	`number`	What role the user has 1=`Viewer`, 2=`VIP`, 3=`Mod`, 4=`Broadcaster`

		Description
`badgeCount`	`number`	The count of badges this user has Example: `3`
`badges`	`List<Twitch.Common.Models.Badge>`	A C# accessible list of emotes used in the chat message
`isModerator`	`boolean`	Is this user a moderator? Example: `true`
`isSubscribed`	`boolean`	Is this user subscribed? Example: `true`
`isVip`	`boolean`	Is this user a VIP? Example: `true`
`monthsSubscribed`	`number`	The amount of months the user is subscribed Example: `3`
`user`	`string`	The display name of the user Example: `TwitchUser123`
`userGroups`	`string`	0.2.5 Comma-delimited list of groups the user is in Example: `Awesome Streamers,Discord Peeps,Top Contributors`
`userId`	`string`	Unique user identifier Example: `718933593`
`userName`	`string`	The login name of the user Example: `twitchuser123`
`userPreviousActive`	`DateTime`	When was this user last active? Example: `8/4/2023 10:56:06 AM`
`userType`	`string`	Streaming service of this user Example: `twitch`

		Description
`broadcastIsAffiliate`	`boolean`	Is the broadcaster an affiliate?
`broadcastIsPartner`	`boolean`	Is the broadcaster a partner? Example: `true`
`broadcastUser`	`string`	The Twitch display name of the broadcaster account Example: `TwitchUser123`
`broadcastUserId`	`string`	The Twitch user ID of the broadcaster account Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`broadcastUserName`	`string`	The Twitch user name of the broadcaster account Example: `twitchuser123`

		Description
`isModerator`	`bool`	Is this user a moderator? Example: `true`
`isSubscribed`	`bool`	Has the user been a member at any time, including the present? Example: `true`
`user`	`string`	The display name of the user Example: `YouTubeUser123`
`userId`	`string`	Unique user identifier Example: `UCI9-KG2xoyh5z-g41IL2jqf`
`userIsSponsor`	`boolean`	Indicates whether the viewer is a current channel member or not
`userName`	`string`	The login name of the user Example: `youtubeuser123`
`userPreviousActive`	`DateTime`	When was this user last active? Example: `8/4/2023 10:56:06 AM`
`userProfileUrl`	`string`	The user's YouTube profile image
`userType`	`string`	Streaming service of this user Example: `youtube`

		Description
`broadcastId`	`string`	The broadcast ID from the livestream Example: `UCI9-KG2xoy`
`broadcastUserId`	`string`	The YouTube user ID of the broadcaster account Example: `UCI9-KG2xoyh5z-g41IL2jqf`
`broadcastUserProfileImage`	`string`	The profile image of the broadcaster account Example: `https://yt3.ggpht.com/ytc/profile-image-id`
`broadcastUsername`	`string`	The YouTube user name of the broadcaster account Example: `youtubeuser123`

		Description
`isModerator`	`bool`	Is this user a moderator? Example: `true`
`isSubscribed`	`bool`	Is this user a subscriber? Example: `true`
`user`	`string`	The display name of the user Example: `TrovoUser123`
`userId`	`string`	Unique user identifier Example: `trovo_678296378`
`userName`	`string`	The login name of the user Example: `trovouser123`
`userPreviousActive`	`DateTime`	When was this user last active? Example: `8/4/2023 10:56:06 AM`
`userType`	`string`	Streaming service of this user Example: `trovo`

General variables are generated by all triggers and are available within all action executions.

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

Command Cooldown

Trigger for when a Command is on Cooldown

Changed

Trigger for when a File/Folder Watcher is Changed