Reference

This page lists an overview of all the events and nodes exposed by TwiWorks, current as of the 2.0 release. It also includes a short description of what they do, as well as the OAuth scope(s) required for their usage. For more information on their usage, please refer to the built-in help text and/or the relevant documentation pages.

TwiWorks Events

Name	Scope(s)	Feature Class	Short Description
OnMessage	user:read:chat	CORE	Triggered when a new message is received
OnCheer	user:read:chat	CORE	Triggered when a user cheers in chat
OnNewSubscription	user:read:chat	CORE	Triggered when a user (re)subscribes to the channel or gifts a sub
OnRaid	user:read:chat	CORE	Triggered when another channel raids the connected channel
OnPointsEvent	channel:read:redemptions	Channel Point Events	Triggered when a user redeems a channel points reward
OnWhisper	user:read:whispers	Whisper Events	Triggered when a user whispers you (the logged in user)
OnFollow	moderator:read:followers	Follower Events	Triggered when a user starts following the connected channel
OnBanEvent	channel:moderate	Ban Events	Triggered when a user gets (temporarily) banned
OnUnbanEvent	channel:moderate	Ban Events	Triggered when a user gets unbanned

TwiWorks Nodes

Type	Name	Scope(s)	Feature Class	Short Description
Async Node	GetTwitchUser	-	CORE	Gets information about a Twitch user from their username
Async Node	Connect To Twitch	user:read:chat (+more depending on enabled features)	CORE	Establishes a connection to the Twitch chat, creates the core UtwitchChatConnector object
Node	SendTwitchMessage	user:write:chat	CORE	Sends a message to the chat
Node	DisconnectFromChat	-	CORE	Closes & cleans a given chat connection
Async Node	RefreshCredentials	-	BACKEND LOGIN	Backend login only – refreshes a user’s OAuth token (default access token expiry is ~3600s)
Async Node	PerformTwitchLogin	-	BACKEND LOGIN	Performs login using the login backend system
Async Node	GetChannelViewers	moderator:read:chatters	MISC	Gets a list of (up to 50) logged-in viewers in chat.
Async Node	GetIsStreaming	-	MISC	Returns whether or not the given channel is live
Async Node	GetIsSubscribed	user:read:subscriptions	MISC	Checks if a given user is subscribed to the connected channel
Async Node	GetNumFollowers	moderator:read:followers	MISC	Gets the number of followers the connected channel has
Async Node	SendAnnouncement	moderator:manage:announcements	MISC	Sends an announcement (/announce command in chat)
Async Node	SendWhisper	user:manage:whispers	MISC	Sends a whisper to a given user. NOTE: delivery may be spotty depending on how Twitch’s spam prevention system is feeling
Async Node	PerformLocalTwitchLogin	-	LOCAL LOGIN	Performs login using the local login system
Async Node	GetEmoteTask	-	EMOTE	Gets the image (UTexture2D) associated with an emoticon
Async Node	GetTwitchEmoteSet	-	EMOTE	Gets information about a given Twitch emote set
Node	CreateTwitchCommand	-	COMMAND SYSTEM	Dynamically creates a new Twitch command
Node	UpdateTwitchCommand	-	COMMAND SYSTEM	Dynamically changes a Twitch command
Node	RemoveTwitchCommand	-	COMMAND SYSTEM	Removes a Twitch command
Node	GetRegisteredTwitchCommands	-	COMMAND SYSTEM	Lists all commands currently registered in the command system
Node	BindToTwitchCommand	-	COMMAND SYSTEM	Binds a function to that gets triggered when a user runs the given command
Node	EnableSlowChat	moderator:manage:chat_settings	CHAT MODERATION	Enables slow mode
Node	DisableSlowChat	moderator:manage:chat_settings	CHAT MODERATION	Disables slow mode
Node	EnableEmoteChat	moderator:manage:chat_settings	CHAT MODERATION	Enables emote-only chat
Node	DisableEmoteChat	moderator:manage:chat_settings	CHAT MODERATION	Disables emote-only chat
Node	EnableR9KChat	moderator:manage:chat_settings	CHAT MODERATION	Enables R9K chat
Node	DisableR9KChat	moderator:manage:chat_settings	CHAT MODERATION	Disables R9K chat
Node	ClearChat	moderator:manage:chat_settings	CHAT MODERATION	Clears the chat history
Node	EnableFollowersOnlyChat	moderator:manage:chat_settings	CHAT MODERATION	Enables followers-only chat
Node	DisableFollowersOnlyChat	moderator:manage:chat_settings	CHAT MODERATION	Disables followers-only chat
Node	GetChatModes	-	CHAT MODERATION	Returns information on which chat modes are currently enables
Async Node	CreatePointsReward	channel:manage:redemptions	CHANNEL POINTS	Dynamically creates a new channel points reward (associated with your App ID, so you have “full control” over it + its redemptions)
Async Node	DeletePointsReward	channel:manage:redemptions	CHANNEL POINTS	Removes a channel points reward
Async Node	GetPointsRewards	channel:read:redemptions OR channel:manage:redemptions	CHANNEL POINTS	Gets information about a channel points reward
Async Node	GetRewardRedemptions	channel:read:redemptions OR channel:manage:redemptions	CHANNEL POINTS	Gets a list of (up to 50) redemptions for the given reward; listening for new redemptions using the OnPointsEvent is highly recommended over polling this function.
Async Node	SetPointsRewardEnabled	channel:manage:redemptions	CHANNEL POINTS	Enables a channel points reward
Async Node	UpdatePointsReward	channel:manage:redemptions	CHANNEL POINTS	Changes the settings of a channel points reward
Async Node	UpdateRedemptionStatus	channel:manage:redemptions	CHANNEL POINTS	Changes a redemption’s status (unfulfilled/fulfilled; used to keep track of which redemptions have been processed & granted)
Async Node	GetBadgeImage	-	BADGE SYSTEM	Gets a badge’s image
Node	GetBadgeIdentifier	-	BADGE SYSTEM	Gets the badge identifier for a badge that is unknown to TwiWorks (e.g. channel-specific, recently added, not documented, etc.)
Node	ParmaBanTwitchUser	moderator:manage:banned_users	USER MODERATION	Permanently bans a chatter
Node	TempBanTwitchUser	moderator:manage:banned_users	USER MODERATION	Temporarily bans a chatter