Gift Subscription

Parameters

Tier

Checkbox

Choose on which tier to trigger the gift bomb

Options: Tier 1, Tier 2, Tier 3

Sub Type

Checkbox

Choose on which sub types to trigger the gift bomb

Options: Public, Anonymous

Months Gifted

Checkbox

Choose on how much months gifted to trigger the gift sub

Options: 1, 3, 6, 12

Range

Select

Filter events between a specified Min and Max

Min and Max are inclusive of the entered values

Any Value - Leave both min and max empty to accept any value
Exact Value - Enter only a Max to trigger on a specific value
Greater Than - Enter only a Min to trigger on any value greater than the specified value
Range - Enter a min and a max to trigger within a desired range

Variables

The following variables will be populated when this trigger executes:

		Description
`anonymous`	`boolean`	Is the gift sub anonymous?
`cumulativeMonths`	`number`	The amount of months the recipient has been subscribed to the channel Example: `1`
`fromGiftBomb`	`boolean`	Is this from a gift bomb? Example: `true`
`monthsGifted`	`number`	The number of prepaid months that the user has gifted `1`, `3`, `6`, `12` Example: `6`
`random`	`boolean`	0.2.5 Whether or not this was a targeted Gift sub, this will only be true for single gift subs that were directly given to a user. Example: `true`
`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 Example: `10`
`systemMessage`	`string`	0.2.5 The system message that was put into Twitch Chat. Example: `Here's another gifted sub for your channel!`
`tier`	`string`	The subscription tier `tier 1`, `tier 2`, `tier 3` Example: `tier 1`
`totalSubsGifted`	`number`	The total amount of subscriptions that the user has gifted Example: `24`
`totalSubsGiftedShared`	`boolean`	0.2.5 A boolean value if the user gifting the sub(s) shares there total gift count. Example: `true`

		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`

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`

Gift Paid Upgrade

title: Gift Paid Upgrade description: Triggered when a user upgrades their gifted subscription twitchService: EventSub version: 0.2.5 variables: commonVariables:

Pay It Forward

Triggered when a user pays forward their gifted subscription