Variables
The following variables will be populated when this trigger executes:
| Description | ||
|---|---|---|
isUpgrade | boolean | Indicates whether the viewer just upgraded from a lower level Example: true |
levelName | string | The name of the Level at which the viewer is a member |
messageId | string | The id of the sponsor event |
publishedAt | DateTime | The time the sponsor event was published at Example: 8/4/2023 10:56:06 AM |
| 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 | ||
|---|---|---|
broadcast.defaultAudioLanguage | string | The default language code for the YouTube Broadcast's Stream Example: en |
broadcast.defaultLanguage | string | The default language code for the YouTube Broadcast's Title and Description Example: en |
broadcast.description | string | The description of the broadcast the message was sent from Example: Super cool YouTube Stream happening now! |
broadcast.id | string | The ID of the broadcast the message was sent from Example: UCI9-KG2xoyh5z-g41IL2jqf |
broadcast.privacy | string | The privacy setting of the broadcast the message was sent from Valid values are Example: public |
broadcast.publishedAt | DateTime | When the YouTube broadcast was first published on YouTube Example: 12/21/2023 9:25:21 AM |
broadcast.status | string | The online status of the broadcast the message was sent from Possible values are, Example: live |
broadcast.tags | string | The tags that are set for the YouTube Broadcast as a comma delimited string, and these tags are case sensitive. Example: Horizontal,Gaming |
broadcast.title | string | The title of the broadcast the message was sent from Example: Really cool stream title |
| 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 |
General variables are generated by all triggers and are available within all action executions.
| Description | ||
|---|---|---|
__source | EventType | The event which triggered the action. 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. 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 |