Shared Sub Gift

Variables

The following variables will be populated when this trigger executes:

		Description
`anonymous`	`boolean`	Returns whether or not the sub was gifted anonymously
`cumulativeMonths`	`number`	The amount of months the recipient has been subscribed to the channel Example: `2`
`fromGiftBomb`	`boolean`	Is this from a gift bomb?
`monthsGifted`	`number`	The number of prepaid months that the user has gifted `1`, `3`, `6`, `12` Example: `6`
`recipientId`	`string`	The recipient user's ID
`recipientUser`	`string`	The recipient user's display name Example: `TwitchUser123`
`recipientUserName`	`string`	The recipient user's login name Example: `twitchuser123`
`subBombCount`	`number`	The amount of gift subs in the gift bomb
`tier`	`string`	The subscription tier `prime`, `tier 1`, `tier 2`, `tier 3` Example: `tier 1`
`totalSubsGifted`	`number`	The total amount of subscriptions that the user has gifted Example: `24`

		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
`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`
`subscriptionTier`	`number`	The subscription tier (T1 = 1000, T2 = 2000, T3 = 3000) (only available if `isSubscribed` is `True`) Example: `3000`
`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
`bits`	`number`	The amount of bits donated Example: `200`
`color`	`string`	Hex value of the user's chat color Example: `#e5e5e5`
`colorB`	`string`	The blue in RGB of the user's chat color Example: `229`
`colorG`	`string`	The green in RGB of the user's chat color Example: `229`
`colorR`	`string`	The red in RGB of the user's chat color Example: `229`
`emoteCount`	`number`	Number of emotes in the chat message
`emotes`	`List<Twitch.Common.Models.Emote>`	A C# accessible list of emotes used in the chat message
`firstMessage`	`boolean`	Is this user a first time chatter? Example: `true`
`fromSharedChat`	`boolean`	Whether or not the message originated from a different broadcaster in shared chat
`inSharedChat`	`boolean`	Whether or not the broadcaster is currently in a shared chat
`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
`isAction`	`boolean`	Is this message a `/me` action? Example: `true`
`isHighlight`	`boolean`	Is this message a Twitch Highlight? Example: `true`
`isReply`	`boolean`	Is this message a reply? Example: `true`
`message`	`string`	Text content of the chat message Example: `Hello!`
`messageCheermotesStripped`	`string`	The chat message with cheer emotes stripped. Example: `Hello!`
`messageStripped`	`string`	The chat message with emotes stripped Example: `Hello!`
`msgId`	`string`	Twitch's message identifier Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`rawInput`	`string`	The message entered
`rawInputEscaped`	`string`	The message escaped
`rawInputUrlEncoded`	`string`	The message URL encoded
`reply.msgBody`	`string`	The text content of the reply, Spaces are replaced by `\s` Example: `My\schat\smessage`
`reply.msgId`	`string`	The message id of the reply Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`reply.threadMsgId`	`string`	The message id of the thread Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`reply.threadUserLogin`	`string`	The user login name of the thread Example: `twitchuser123`
`reply.userId`	`string`	The user id from the user who sent the reply Example: `718933593`
`reply.userLogin`	`string`	The user login from the user who sent the reply Example: `twitchuser123`
`reply.userName`	`string`	The user name from the user who sent the reply Example: `TwitchUser123`
`role`	`number`	The role of the user 1=`Viewer`, 2=`VIP`, 3=`Moderator`, 4=`Broadcaster` Example: `1`

		Description
`source.isModerator`	`boolean`	Whether or not the source chat owner is a moderator in your channel Example: `true`
`source.isSubscribed`	`boolean`	Whether or not the source chat owner is subscribed in your channel
`source.isVip`	`boolean`	Whether or not the source chat owner is a VIP in your channel
`source.userId`	`string`	The Twitch user ID from which chat the event originated Example: `123456789`
`source.userLogin`	`string`	The Twitch user login name from which chat the event originated Example: `twitchuser123`
`source.userName`	`string`	The Twitch display name from which chat the event originated Example: `TwitchUser123`

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`

Shared Sub

Triggered When a User Subscribes in a Shared Chat

Shared Chat User Banned

Trigger for When a Twitch User Is Banned in a Shared Chat