Twitch
Full Twitch integration with real-time events via EventSub, IRC chat, channel point rewards, polls, predictions, moderation, and comprehensive API access.
Overview
FaustBot provides deep integration with Twitch through the Helix API and EventSub WebSocket, enabling real-time reactions to stream events and complete control over your channel.
Real-time Events
Follows, subs, raids, cheers, and more via EventSub.
Chat Integration
Send messages, announcements, and whispers.
Channel Points
Manage rewards and handle redemptions.
Polls & Predictions
Create and manage interactive features.
Moderation
Ban, timeout, VIP, and chat mode control.
Stream Control
Update title, game, run ads, create clips.
Setup
Connecting Your Twitch Account
Open Twitch Settings
In FaustBot, navigate to Platforms in the sidebar and select Twitch.
Login with Twitch
Click Login with Twitch. A browser window will open for you to authorize FaustBot to access your Twitch account.
Authorize Permissions
Review and accept the requested permissions. FaustBot needs access to chat, channel management, moderation, and other features to function properly.
Automatic Connection
Once authorized, FaustBot will automatically connect to Twitch chat and EventSub. Enable Auto-Connect to reconnect automatically when FaustBot starts.
Bot Account
Optionally connect a separate bot account to send messages as a different user. This keeps your broadcaster account messages distinct from automated responses.
Triggers
React to real-time events from your Twitch channel:
Subscription Events
New Follower Someone followed your channelSubscription New subscription (any tier)Resub Message Subscriber shared a resub messageGift Subscription Someone gifted subs to the channelSubscription Ended A subscription was not renewedMonetization Events
Cheer Bits were cheered in chatChannel Point Redemption Custom reward was redeemedCharity Donation Donation to charity campaignStream Events
Stream Online Your stream went liveStream Offline Your stream endedRaid Received Another streamer raided youChannel Update Title, game, or tags changedAd Break Started A commercial break beganInteractive Events
Poll Started/Progress/Ended Poll lifecycle eventsPrediction Started/Locked/Ended Prediction lifecycle eventsHype Train Started/Progress/Ended Hype train lifecycle eventsGoal Started/Progress/Ended Channel goal lifecycle eventsChat Events
Chat Message Message sent in chatFirst Words User's first message of the streamUser Joined/Left User joined or left the chatShoutout Received Another streamer shouted you outModeration Events
VIP Added/Removed VIP status changedShield Mode Started/Ended Shield mode toggledAutoMod Message Held Message flagged by AutoModSuspicious User Message Low-trust user sent a messageUnban Request Created/Resolved Unban request lifecycleEffects
Chat Effects
Send Message
Send a chat message.
Announce
Send colored announcement.
Shoutout
Shoutout another streamer.
Whisper
Send a private message.
Moderation Effects
Timeout
Temporarily ban a user.
Ban/Unban
Permanently ban or unban.
Clear Chat
Clear all chat messages.
Slow Mode
Limit message frequency.
Sub-Only Mode
Restrict chat to subs.
Emote-Only Mode
Allow only emotes.
Follower-Only Mode
Restrict to followers.
Add/Remove VIP
Manage VIP status.
Add/Remove Mod
Manage moderator status.
Warn User
Send an official warning.
Shield Mode
Toggle shield mode.
Block/Unblock
Block users from channel.
Channel Effects
Set Title
Change stream title.
Set Game
Change stream category.
Run Ad
Start a commercial break.
Snooze Ad
Delay next scheduled ad.
Create Marker
Add a stream marker.
Create Clip
Create a clip.
Raid
Start a raid to another channel.
Cancel Raid
Cancel an active raid.
Channel Point Reward Effects
Enable Reward
Make reward available.
Disable Reward
Make reward unavailable.
Pause/Unpause
Temporarily pause reward.
Fulfill Redemption
Complete a redemption.
Cancel Redemption
Refund and cancel.
Update Cost/Title
Modify reward properties.
Poll & Prediction Effects
Create Poll
Start a new poll.
End Poll
End poll early.
Create Prediction
Start a new prediction.
Resolve Prediction
Select winning outcome.
Cancel Prediction
Refund all points.
Guest Star Effects
Create Session
Start Guest Star session.
End Session
End Guest Star session.
Invite Guest
Invite user to session.
Remove Guest
Remove from session.
Scripting API
Access Twitch features from your scripts using the CPH API:
Chat Messages
# Send a message to chat
CPH.TwitchSendMessage("Hello chat!")
# Send a reply to a message
CPH.TwitchSendMessage("Thanks for the follow!", replyToId="%msgId%")
# Send an announcement (colored)
CPH.TwitchAnnounce("Stream starting in 5 minutes!", "purple")Moderation
# Timeout a user (600 seconds default)
CPH.TwitchTimeout("%userId%", 300, "Spamming")
# Ban a user
CPH.TwitchBan("%userId%", "Rule violation")
# Unban a user
CPH.TwitchUnban("%userId%")
# Add/remove VIP
CPH.TwitchAddVip("%userId%")
CPH.TwitchRemoveVip("%userId%")Channel Control
# Update stream title
CPH.TwitchSetTitle("Playing some games!")
# Update game/category
CPH.TwitchSetGame("Just Chatting")
# Create a clip
CPH.TwitchCreateClip()
# Create a stream marker
CPH.TwitchCreateMarker("Epic moment!")
# Run a commercial
CPH.TwitchRunAd(60) # 60 second adPolls & Predictions
# Create a poll
CPH.TwitchCreatePoll("What game next?", ["Minecraft", "Fortnite", "Valorant"], 60)
# Create a prediction
CPH.TwitchCreatePrediction("Will I win?", ["Yes", "No"], 120)
# Resolve a prediction (use outcome ID)
CPH.TwitchResolvePrediction("%predictionId%", "%winningOutcomeId%")Channel Point Rewards
# Enable/disable a reward
CPH.TwitchEnableReward("%rewardId%")
CPH.TwitchDisableReward("%rewardId%")
# Fulfill a redemption
CPH.TwitchFulfillRedemption("%rewardId%", "%redemptionId%")
# Cancel a redemption (refund points)
CPH.TwitchCancelRedemption("%rewardId%", "%redemptionId%")
# Update reward cost
CPH.TwitchUpdateRewardCost("%rewardId%", 500)See the full API reference for all Twitch methods.
Example Use Cases
Welcome Raiders
Trigger on Raid Received to send a thank-you message and play a sound alert
when another streamer raids your channel.
Auto-Shoutout
Automatically shoutout raiders or specific users when they chat for the first time
using the First Words trigger.
Dynamic Rewards
Enable or disable channel point rewards based on your current game or stream status. Great for game-specific rewards.
Hype Train Celebration
Trigger special effects and sounds when a hype train reaches certain levels, or celebrate when it completes successfully.
Chat Games
Create predictions for in-game outcomes and automatically resolve them based on game events or commands.
Mod Commands
Create chat commands that only moderators can use to control stream settings, run ads, or manage rewards.