AutoMod
Events raised when AutoMod holds, updates or reviews a message, and when a broadcaster changes their AutoMod settings or terms.
- AutoMod Message Hold
- Notifies a user if their chat message was caught by AutoMod for review.
- AutoMod Message Hold V2
- A user is notified if a message is caught by automod for review. Only public blocked terms trigger notifications, not private ones.
- AutoMod Message Update
- A message in the automod queue had its status changed.
- AutoMod Message Update V2
- A message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones.
- AutoMod Settings Update
- A notification is sent when a broadcaster's automod settings are updated.
- AutoMod Terms Update
- A notification is sent when a broadcaster's automod terms are updated. Changes to private terms are not sent.
Channel
Actions on Twitch relating to a Twitch channel.
- Channel Ad Break Begin
- A midroll commercial break has started running.
- Channel Bits Use
- A notification is sent whenever Bits are used on a channel.
- Channel Cheer
- A user cheers on the specified channel.
- Channel Custom Power-ups Redemption Add
- A viewer has redeemed a custom Power-up on the specified channel.
- Channel Follow
- A specified channel receives a follow.
- Channel Raid
- A broadcaster raids another broadcaster's channel.
- Shoutout Create
- Sends a notification when the specified broadcaster sends a Shoutout.
- Shoutout Received
- Sends a notification when the specified broadcaster receives a Shoutout.
- Channel Subscribe
- A notification is sent when a specified channel receives a subscriber. This does not include resubscribes.
- Channel Subscription End
- A notification when a subscription to the specified channel ends.
- Channel Subscription Gift
- A notification when a viewer gives a gift subscription to one or more users in the specified channel.
- Channel Subscription Message
- A notification when a user sends a resubscription chat message in a specific channel.
- Channel Update
- A broadcaster updates their channel properties e.g., category, title, content classification labels, broadcast, or language.
- Channel VIP Add
- A VIP is added to the channel.
- Channel VIP Remove
- A VIP is removed from the channel.
Channel Moderation
Events raised when a moderation event happens on a Twitch channel.
- Channel Ban
- A viewer is banned from the specified channel.
- Channel Moderate
- A moderator performs a moderation action in a channel.
- Channel Moderate V2
- A moderator performs a moderation action in a channel. Includes warnings.
- Channel Moderator Add
- Moderator privileges were added to a user on a specified channel.
- Channel Moderator Remove
- Moderator privileges were removed from a user on a specified channel.
- Shield Mode Begin
- Sends a notification when the broadcaster activates Shield Mode.
- Shield Mode End
- Sends a notification when the broadcaster deactivates Shield Mode.
- Channel Suspicious User Message
- A chat message has been sent by a suspicious user.
- Channel Suspicious User Update
- A suspicious user has been updated.
- Channel Unban
- A viewer is unbanned from the specified channel.
- Channel Unban Request Create
- A user creates an unban request.
- Channel Unban Request Resolve
- An unban request has been resolved.
- Channel Warning Acknowledgement
- A user acknowledges a warning. Broadcasters and moderators can see the warning's details.
- Channel Warning Send
- A user is sent a warning. Broadcasters and moderators can see the warning's details.
Channel Points
Events raised when a broadcaster manages their Channel Points rewards, and when a viewer redeems an automatic or custom reward.
- Channel Points Automatic Reward Redemption Add
- A viewer has redeemed an automatic channel points reward on the specified channel.
- Channel Points Automatic Reward Redemption Add V2
- A viewer has redeemed an automatic channel points reward on the specified channel.
- Channel Points Custom Reward Redemption Add
- A viewer has redeemed a custom channel points reward on the specified channel.
- Channel Points Custom Reward Redemption Update
- A redemption of a channel points custom reward has been updated for the specified channel.
- Channel Points Custom Reward Add
- A custom channel points reward has been created for the specified channel.
- Channel Points Custom Reward Remove
- A custom channel points reward has been removed from the specified channel.
- Channel Points Custom Reward Update
- A custom channel points reward has been updated for the specified channel.
Charity
Events raised as a broadcaster's charity campaign starts, receives donations, progresses and stops.
- Charity Donation
- Sends an event notification when a user donates to the broadcaster's charity campaign.
- Charity Campaign Progress
- Sends an event notification when progress is made towards the campaign's goal or when the broadcaster changes the fundraising goal.
- Charity Campaign Start
- Sends an event notification when the broadcaster starts a charity campaign.
- Charity Campaign Stop
- Sends an event notification when the broadcaster stops a charity campaign.
Chat
Events raised by activity in a channel's chat room — messages, deletions, holds, and the shared chat sessions a channel takes part in.
- Channel Chat Settings Update
- A notification for when a broadcaster's chat settings are updated.
- Channel Chat Clear
- A moderator or bot has cleared all messages from the chat room.
- Channel Chat Clear User Messages
- A moderator or bot has cleared all messages from a specific user.
- Channel Chat Message
- Any user sends a message to a specific chat room.
- Channel Chat Message Delete
- A moderator has removed a specific message.
- Channel Chat Notification
- A notification for when an event that appears in chat has occurred.
- Channel Chat User Message Hold
- A user is notified if their message is caught by automod.
- Channel Chat User Message Update
- A user is notified if their message's automod status is updated.
- Channel Shared Chat Session Begin
- A notification when a channel becomes active in an active shared chat session.
- Channel Shared Chat Session End
- A notification when a channel leaves a shared chat session or the session ends.
- Channel Shared Chat Session Update
- A notification when the active shared chat session the channel is in changes.
Conduit
Events raised when a conduit's shards change state.
- Conduit Shard Disabled
- Sends a notification when EventSub disables a shard due to the status of the underlying transport changing.
Drop
Events raised when a Drop entitlement is granted.
- Drop Entitlement Grant
- An entitlement for a Drop is granted to a user.
Extension
Events raised when a viewer completes a Bits transaction in an extension.
- Extension Bits Transaction Create
- A Bits transaction occurred for a specified Twitch Extension.
Goal
Events raised as a broadcaster's creator goal starts, progresses and ends.
- Goal Begin
- Get notified when a broadcaster begins a goal.
- Goal End
- Get notified when a broadcaster ends a goal.
- Goal Progress
- Get notified when progress (either positive or negative) is made towards a broadcaster's goal.
Guest Star
Events raised as a Guest Star session begins and ends, a guest or slot changes, and the host updates their Guest Star preferences.
- Channel Guest Star Guest Update
- BetaA guest or a slot is updated in an active Guest Star session.
- Channel Guest Star Session Begin
- BetaThe host began a new Guest Star session.
- Channel Guest Star Session End
- BetaA running Guest Star session has ended.
- Channel Guest Star Settings Update
- BetaThe host preferences for Guest Star have been updated.
Hype Train
Events raised when a Hype Train starts, progresses, or ends on a channel.
- Hype Train Begin
- A Hype Train begins on the specified channel.
- Hype Train End
- A Hype Train ends on the specified channel.
- Hype Train Progress
- A Hype Train makes progress on the specified channel.
Poll
Events raised as a poll starts, collects votes and ends on a channel.
- Channel Poll Begin
- A poll started on a specified channel.
- Channel Poll End
- A poll ended on a specified channel.
- Channel Poll Progress
- Users respond to a poll on a specified channel.
Prediction
Events raised as a Channel Points Prediction starts, takes predictions, locks and resolves.
- Channel Prediction Begin
- A Prediction started on a specified channel.
- Channel Prediction End
- A Prediction ended on a specified channel.
- Channel Prediction Lock
- A Prediction was locked on a specified channel.
- Channel Prediction Progress
- Users participated in a Prediction on a specified channel.
Stream
Events raised when a broadcaster starts or stops streaming.
- Stream Offline
- The specified broadcaster stops a stream.
- Stream Online
- The specified broadcaster starts a stream.
User
Events raised when a user updates their account, manages your app's authorization, or receives a whisper.
- User Authorization Grant
- A user's authorization has been granted to your client id.
- User Authorization Revoke
- A user's authorization has been revoked for your client id.
- User Update
- A user has updated their account.
- Whisper Received
- A user receives a whisper.