Guest Star Guest Update

Parameters

Scene Name

Select

Defaults to 'Any', but can select 'Selected', 'Backstage', 'Invited', 'Live', 'Ready', or 'Removed'

The following variables will be populated when this trigger executes:

		Description
`guestUserId`	`string`	user ID of the guest Example: `161545467`
`guestUserLogin`	`string`	login name of the guest Example: `lyfesaver74`
`guestUserName`	`string`	display name of the guest Example: `Lyfesaver74`
`hostAudioEnabled`	`bool`	audio enabled status Example: `True/False (<null> if not joined)`
`hostVideoEnabled`	`bool`	video enabled status Example: `True/False (<null> if not joined)`
`hostVolume`	`number`	video enabled status Example: `100 (<null> if not joined)`
`moderatorUserId`	`string`	user ID of the moderator who updated the guest settings Example: `161545467`
`moderatorUserLogin`	`string`	login name of the moderator who updated the guest settings Example: `lyfesaver74`
`moderatorUserName`	`string`	display name of the moderator who updated the guest settings Example: `Lyfesaver74`
`sessionId`	`string`	ID of the current session Example: `2iWsVXrc5WBsHr8ILWXYa9mAmOo`
`slotId`	`string`	ID of the guest slot Example: `123 (<null> if not joined)`
`state`	`string`	guest update state Example: `invited, backstage, ready`

		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`

Stream Update

Trigger for a Twitch Stream Update

Guest Star Session Begin

Trigger for when a Guest Star session begins