All Classes and Interfaces
Class
Description
This event is a base for events that originate from a channel
A pool for connections to be created and destroyed.
AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2 extends AbstractConnectionPool<C>,B extends AbstractConnectionPool.AbstractConnectionPoolBuilder<C,C2,B>>
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Analytics - Date Range
Deprecated.
in favor of
AnnouncementColorDeprecated.
in favor of
AnnouncementColorApplicationEventSubCondition.ApplicationEventSubConditionBuilder<C extends ApplicationEventSubCondition,B extends ApplicationEventSubCondition.ApplicationEventSubConditionBuilder<C,B>>
Fired when certain automatic rewards are redeemed.
Represents a region of a chat message that was flagged by AutoMod.
The action to take on a message held for review by AutoMod.
Configuration of the Automod category sensitivity levels, between 0 and 4 (inclusive) each.
Notifies moderators when AutoMod held a user's message for review.
Notifies when a message in the AutoMod queue has its status changed.
Fires when a broadcaster’s automod settings are updated.
Metadata associated with the automod terms changes.
Fires when a broadcaster’s AutoMod terms are updated.
Determines whether various types of users can request the broadcaster to share their bans.
Fired when a channel changes their ban sharing settings.
BaseCommand<T extends com.apollographql.apollo.api.Operation.Data>
GraphQL Base HystrixCommand
Called when a user earns a new bits badge tier.
Bits Leaderboard
Bits Leaderboard Entry
Deprecated.
Twitch no longer supports bits on polls.
Deprecated.
CampaignEventSubCondition.CampaignEventSubConditionBuilder<C extends CampaignEventSubCondition,B extends CampaignEventSubCondition.CampaignEventSubConditionBuilder<C,B>>
Categories that matched the search query
The channel.ad_break.begin subscription type sends a notification when a user runs a midroll commercial break,
either manually or automatically via ads manager.
ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<C extends ChannelAdBreakCondition,B extends ChannelAdBreakCondition.ChannelAdBreakConditionBuilder<C,B>>
ChannelBanCondition.ChannelBanConditionBuilder<C extends ChannelBanCondition,B extends ChannelBanCondition.ChannelBanConditionBuilder<C,B>>
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
A viewer is banned from the specified channel.
Channel Cache
Deprecated.
This event gets called when a channel changes the game
Deprecated.
This event gets called when a channel changes the title
ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<C extends ChannelCharityCampaignCondition,B extends ChannelCharityCampaignCondition.ChannelCharityCampaignConditionBuilder<C,B>>
Channel Charity Campaign Donate
Sends a notification when a moderator or bot clears all messages from the chat room.
ChannelChatCondition.ChannelChatConditionBuilder<C extends ChannelChatCondition,B extends ChannelChatCondition.ChannelChatConditionBuilder<C,B>>
Sends a notification when any user sends a message to a specific chat room, effectively replicating IRC PRIVMSG.
Sends a notification when a USERNOTICE event that appears in chat occurs,
such as someone subscribing to the channel or a subscription is gifted.
This event sends a notification when a broadcaster’s chat settings are updated.
ChannelCheerCondition.ChannelCheerConditionBuilder<C extends ChannelCheerCondition,B extends ChannelCheerCondition.ChannelCheerConditionBuilder<C,B>>
A user cheers on the specified channel.
Sends a notification when a moderator or bot clears all messages for a specific user,
which occurs when the user has been timed out or banned.
Called when a new clip is created in a channel.
ChannelEventSubCondition.ChannelEventSubConditionBuilder<C extends ChannelEventSubCondition,B extends ChannelEventSubCondition.ChannelEventSubConditionBuilder<C,B>>
ChannelFollowCondition.ChannelFollowConditionBuilder<C extends ChannelFollowCondition,B extends ChannelFollowCondition.ChannelFollowConditionBuilder<C,B>>
Deprecated.
Without prior notice, Twitch has restricted this subscription to client_id's that were using it on 2023-02-17.
A specified channel receives a follow.
ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<C extends ChannelFollowV2Condition,B extends ChannelFollowV2Condition.ChannelFollowV2ConditionBuilder<C,B>>
Generic condition when a broadcaster can be either on the receiving or giving end of the event type.
ChannelFromToEventSubCondition.ChannelFromToEventSubConditionBuilder<C extends ChannelFromToEventSubCondition,B extends ChannelFromToEventSubCondition.ChannelFromToEventSubConditionBuilder<C,B>>
Notifies the subscriber when the specified broadcaster begins a goal.
Notifies the subscriber when the specified broadcaster ends a goal.
Notifies the subscriber when progress is made towards the specified broadcaster’s goal.
Deprecated.
This event gets called when a channel goes live
Deprecated.
This event gets called when a channel goes offline
Information for channels
This event gets called when a user joins a channel.
A chat instance failed to join (or stay joined to) a channel AND removeChannelOnJoinFailure was enabled,
resulting in removal from the instance's current channels.
This event gets called when a user leaves the channel.
This event gets called when an action message (/me text) is received in a channel.
Sends a notification when a moderator removes a specific message.
This event gets called when a message is received in a channel.
Fires when a moderator performs a moderation action in a channel.
ChannelModeratorAddCondition.ChannelModeratorAddConditionBuilder<C extends ChannelModeratorAddCondition,B extends ChannelModeratorAddCondition.ChannelModeratorAddConditionBuilder<C,B>>
The channel.moderator.add subscription type sends a notification when a user is given moderator privileges on a specified channel.
ChannelModeratorRemoveCondition.ChannelModeratorRemoveConditionBuilder<C extends ChannelModeratorRemoveCondition,B extends ChannelModeratorRemoveCondition.ChannelModeratorRemoveConditionBuilder<C,B>>
The channel.moderator.remove subscription type sends a notification when a user has moderator privileges removed on a specified channel.
Deprecated.
ChatChannel Notice Event
This subscription type sends a notification when a viewer has redeemed an automatic channel points reward on the specified channel.
ChannelPointsCustomRewardAddCondition.ChannelPointsCustomRewardAddConditionBuilder<C extends ChannelPointsCustomRewardAddCondition,B extends ChannelPointsCustomRewardAddCondition.ChannelPointsCustomRewardAddConditionBuilder<C,B>>
A custom channel points reward has been created for the specified channel.
ChannelPointsCustomRewardRedemptionAddCondition.ChannelPointsCustomRewardRedemptionAddConditionBuilder<C extends ChannelPointsCustomRewardRedemptionAddCondition,B extends ChannelPointsCustomRewardRedemptionAddCondition.ChannelPointsCustomRewardRedemptionAddConditionBuilder<C,B>>
A viewer has redeemed a custom channel points reward on the specified channel.
ChannelPointsCustomRewardRedemptionUpdateCondition.ChannelPointsCustomRewardRedemptionUpdateConditionBuilder<C extends ChannelPointsCustomRewardRedemptionUpdateCondition,B extends ChannelPointsCustomRewardRedemptionUpdateCondition.ChannelPointsCustomRewardRedemptionUpdateConditionBuilder<C,B>>
A redemption of a channel points custom reward has been updated for the specified channel.
ChannelPointsCustomRewardRemoveCondition.ChannelPointsCustomRewardRemoveConditionBuilder<C extends ChannelPointsCustomRewardRemoveCondition,B extends ChannelPointsCustomRewardRemoveCondition.ChannelPointsCustomRewardRemoveConditionBuilder<C,B>>
A custom channel points reward has been removed from the specified channel.
ChannelPointsCustomRewardUpdateCondition.ChannelPointsCustomRewardUpdateConditionBuilder<C extends ChannelPointsCustomRewardUpdateCondition,B extends ChannelPointsCustomRewardUpdateCondition.ChannelPointsCustomRewardUpdateConditionBuilder<C,B>>
A custom channel points reward has been updated for the specified channel.
ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<C extends ChannelPollBeginCondition,B extends ChannelPollBeginCondition.ChannelPollBeginConditionBuilder<C,B>>
ChannelPollEndCondition.ChannelPollEndConditionBuilder<C extends ChannelPollEndCondition,B extends ChannelPollEndCondition.ChannelPollEndConditionBuilder<C,B>>
ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<C extends ChannelPollProgressCondition,B extends ChannelPollProgressCondition.ChannelPollProgressConditionBuilder<C,B>>
ChannelPredictionBeginCondition.ChannelPredictionBeginConditionBuilder<C extends ChannelPredictionBeginCondition,B extends ChannelPredictionBeginCondition.ChannelPredictionBeginConditionBuilder<C,B>>
ChannelPredictionEndCondition.ChannelPredictionEndConditionBuilder<C extends ChannelPredictionEndCondition,B extends ChannelPredictionEndCondition.ChannelPredictionEndConditionBuilder<C,B>>
ChannelPredictionLockCondition.ChannelPredictionLockConditionBuilder<C extends ChannelPredictionLockCondition,B extends ChannelPredictionLockCondition.ChannelPredictionLockConditionBuilder<C,B>>
ChannelPredictionProgressCondition.ChannelPredictionProgressConditionBuilder<C extends ChannelPredictionProgressCondition,B extends ChannelPredictionProgressCondition.ChannelPredictionProgressConditionBuilder<C,B>>
ChannelRaidCondition.ChannelRaidConditionBuilder<C extends ChannelRaidCondition,B extends ChannelRaidCondition.ChannelRaidConditionBuilder<C,B>>
A broadcaster raids another broadcaster’s channel.
Channels that matched the search query
ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<C extends ChannelShoutoutCondition,B extends ChannelShoutoutCondition.ChannelShoutoutConditionBuilder<C,B>>
Called upon successfully joining a channel, or when a moderator updates a public chat room setting.
The possible chat room settings that can be configured.
Abstract Channel State Event
ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<C extends ChannelSubscribeCondition,B extends ChannelSubscribeCondition.ChannelSubscribeConditionBuilder<C,B>>
A notification when a specified channel receives a subscriber.
The channel.subscription.end subscription type sends a notification when a subscription to the specified channel expires.
ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<C extends ChannelSubscriptionGiftCondition,B extends ChannelSubscriptionGiftCondition.ChannelSubscriptionGiftConditionBuilder<C,B>>
The channel.subscription.gift subscription type sends a notification when a user gives one or more gifted subscriptions in a channel.
ChannelSubscriptionMessageCondition.ChannelSubscriptionMessageConditionBuilder<C extends ChannelSubscriptionMessageCondition,B extends ChannelSubscriptionMessageCondition.ChannelSubscriptionMessageConditionBuilder<C,B>>
The channel.subscription.message subscription type sends a notification when a user sends a re-subscription chat message in a specific channel.
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
ChannelUnbanCondition.ChannelUnbanConditionBuilder<C extends ChannelUnbanCondition,B extends ChannelUnbanCondition.ChannelUnbanConditionBuilder<C,B>>
A viewer is unbanned from the specified channel.
ChannelUnsubscribeCondition.ChannelUnsubscribeConditionBuilder<C extends ChannelUnsubscribeCondition,B extends ChannelUnsubscribeCondition.ChannelUnsubscribeConditionBuilder<C,B>>
ChannelUpdateCondition.ChannelUpdateConditionBuilder<C extends ChannelUpdateCondition,B extends ChannelUpdateCondition.ChannelUpdateConditionBuilder<C,B>>
Deprecated.
in favor of
ChannelUpdateV2EventDeprecated.
in favor of
ChannelUpdateV2TypeA broadcaster updates their channel properties e.g., category, title, content classification labels, or broadcast language.
This subscription type sends a notification when a VIP is added to the channel.
This subscription type sends a notification when a VIP is removed from the channel.
Sends a notification when a warning is acknowledged by a user.
Sends a notification when a warning is sent to a user.
The charity campaign that the broadcaster is currently running.
Sends notifications when progress is made towards the campaign’s goal or when the broadcaster changes the fundraising goal.
Sends a notification when the broadcaster starts a charity campaign.
Sends a notification when the broadcaster stops a charity campaign.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Intercepts and forwards outbound IRC messages containing commands to the Helix API, when able.
Chat Connection Event
Deprecated.
Meta-info regarding the parent message being replied to.
This event gets called when a user receives bits.
Available Cheermotes
Clip
Clip List
Deprecated.
Twitch decommissioned entitlement code related endpoints on 2023-02-27.
Deprecated.
Twitch decommissioned entitlement code related endpoints on 2023-02-27.
Twitch requires certain GQL calls to be sent with an appropriate id header, which is computed here
This event gets called when a message is received in a channel.
Follow User
Unfollow User
Commercials attempted
ConduitCondition.ConduitConditionBuilder<C extends ConduitCondition,B extends ConduitCondition.ConduitConditionBuilder<C,B>>
The conduit.shard.disabled subscription type sends a notification when EventSub disables a shard
due to the status of the underlying transport changing.
Fired when a websocket shard unexpected disconnected and could not be re-associated with the conduit after reconnecting.
Module Configuration
Content classification tags that indicate that a stream may not be suitable for certain viewers.
Information about the available content classification labels.
Serializes
Collection<ContentClassificationState> within ChannelInformation
for TwitchHelix.updateChannelInformation(String, String, ChannelInformation)
where ContentClassification.MATURE_GAME is not included in ChannelInformation.getContentClassificationLabels()
since this label is controlled by the game category (rather than the user).Clip Data
Clip Data
CreatorGoalsCondition.CreatorGoalsConditionBuilder<C extends CreatorGoalsCondition,B extends CreatorGoalsCondition.CreatorGoalsConditionBuilder<C,B>>
Deprecated.
the crowd chant experiment was disabled by Twitch on 2022-02-02
Deprecated.
the crowd chant experiment was disabled by Twitch on 2022-02-02
CustomReward.GlobalCooldownSetting.GlobalCooldownSettingBuilder<C extends CustomReward.GlobalCooldownSetting,B extends CustomReward.GlobalCooldownSetting.GlobalCooldownSettingBuilder<C,B>>
CustomReward.MaxPerStreamSetting.MaxPerStreamSettingBuilder<C extends CustomReward.MaxPerStreamSetting,B extends CustomReward.MaxPerStreamSetting.MaxPerStreamSettingBuilder<C,B>>
CustomReward.MaxPerUserPerStreamSetting.MaxPerUserPerStreamSettingBuilder<C extends CustomReward.MaxPerUserPerStreamSetting,B extends CustomReward.MaxPerUserPerStreamSetting.MaxPerUserPerStreamSettingBuilder<C,B>>
CustomReward.Setting.SettingBuilder<C extends CustomReward.Setting,B extends CustomReward.Setting.SettingBuilder<C,B>>
When serializing
CustomReward for
TwitchHelix.createCustomReward(String, String, CustomReward) or
TwitchHelix.updateCustomReward(String, String, String, CustomReward),
Twitch requires MaxPerStreamSetting, MaxPerUserPerStreamSetting, and GlobalCooldownSetting
to be sent unwrapped (i.e., in the root of the object).CustomRewardEventSubCondition.CustomRewardEventSubConditionBuilder<C extends CustomRewardEventSubCondition,B extends CustomRewardEventSubCondition.CustomRewardEventSubConditionBuilder<C,B>>
Fired when a single message was deleted over IRC by a moderator via
/delete <target-msg-id>Deprecated.
in favor of
ChannelMessageEvent.getElevatedChatPayment()This event gets called when a user receives a donation from any source.
DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<C extends DropEntitlementGrantCondition,B extends DropEntitlementGrantCondition.DropEntitlementGrantConditionBuilder<C,B>>
This subscription type sends a notification when an entitlement for a Drop is granted to a user.
An entitlement is the link between a User and a Benefit.
Emote Only State Event
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Called when Twitch decides to close our EventSocket.
Called when the connection state of an EventSocket changes.
Called when an EventSocket fails to delete a subscription via the Helix API.
Called when an EventSocket successfully deletes a subscription via the Helix API.
Called when an EventSocket fails to register subscription with the Helix API.
Called when an EventSocket successfully registers a subscription with the Helix API.
Fired when a
TwitchEventSocket receives a
SocketMessageType.SESSION_WELCOME message.EventSubCondition.EventSubConditionBuilder<C extends EventSubCondition,B extends EventSubCondition.EventSubConditionBuilder<C,B>>
Thread-safe, configurable helper for applying the exponential backoff algorithm with optional jitter and/or truncation.
Called when a user extends their existing subscription into a future month.
Extension
Extension Active List
Extension Analytics
Extension Analytics List
ExtensionBitsTransactionCreateCondition.ExtensionBitsTransactionCreateConditionBuilder<C extends ExtensionBitsTransactionCreateCondition,B extends ExtensionBitsTransactionCreateCondition.ExtensionBitsTransactionCreateConditionBuilder<C,B>>
This subscription type sends a notification when a new transaction is created for a Twitch Extension.
ExtensionEventSubCondition.ExtensionEventSubConditionBuilder<C extends ExtensionEventSubCondition,B extends ExtensionEventSubCondition.ExtensionEventSubConditionBuilder<C,B>>
Extension List
Pagination
Known "type" enum values
Known "product_type" enum values.
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
The AutoMod moderation categories.
Follow
Followers Only State Event
This event gets called when a channel gets a new follower.
Deprecated.
Twitch no longer fires this unofficial event.
Deprecated.
Twitch no longer fires this unofficial event.
Follow List
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Game
Game Analytics
Game Analytics List
Game List
Game Top List
This event occurs when a recipient of a multi-month gift sub
enters a new month of the subscription, and shares a
re-subscription message, despite no additional monetary
transaction accompanying their message.
Metadata for when a user (who has a gifted sub) gifts a sub to another user.
This event gets called when a user gifts x subscriptions to *random* users in chat.
Called when a user upgrades to a paid subscription from previously being gifted a subscription.
The type of goal.
Hearthstone Metadata
Pagination
Data for creating Stream Markers.
Deprecated.
Deprecated.
Deprecated.
Twitch is removing host mode on October 3, 2022
Deprecated.
Twitch is removing host mode on October 3, 2022
HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<C extends HypeTrainBeginCondition,B extends HypeTrainBeginCondition.HypeTrainBeginConditionBuilder<C,B>>
A hype train begins on the specified channel.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Twitch no longer fires this event.
HypeTrainEndCondition.HypeTrainEndConditionBuilder<C extends HypeTrainEndCondition,B extends HypeTrainEndCondition.HypeTrainEndConditionBuilder<C,B>>
A hype train ends on the specified channel.
Hype Train Events
HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<C extends HypeTrainProgressCondition,B extends HypeTrainProgressCondition.HypeTrainProgressConditionBuilder<C,B>>
A hype train makes progress on the specified channel.
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
Deprecated.
Twitch is removing host mode on October 3, 2022
IRC Event Handler
This event gets called when we receive a raw irc message.
Injects the content-type application/json into all PUT,PATCH,POST requests that didn't specify a content-type
Escapes a string so that it can be safely inserted in an existing JSON string that is within the
BodyDeprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getModerators
Deprecated.
Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getChannelVips
Deprecated.
With chat commands decommissioned, this event is no longer fired; migrate to
TwitchHelix#deleteChatMessages.Deprecated.
With chat commands decommissioned, this event is no longer fired; migrate to
TwitchHelix#deleteChatMessages.EventSub equivalent of the
msg-id IRC tag.Fired when the broadcaster or a moderator publishes an accented message via
/announce.Deprecated.
Twitch decommissioned this API; please migrate to EventSub
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<C extends ModeratorEventSubCondition,B extends ModeratorEventSubCondition.ModeratorEventSubConditionBuilder<C,B>>
Module Disabled Event
Module Enabled Event
Module Loader
The color to use for the user’s name in chat.
API Error: Not Found
The documented possible values of
ChannelNoticeEvent.getMsgId().Overwatch Metadata
Overwatch Hero
Overwatch Player
Calls when a user pays forward a gift.
The channel.poll.begin subscription type sends a notification when a poll begins on the specified channel.
The channel.poll.end subscription type sends a notification when a poll ends on the specified channel.
The channel.poll.progress subscription type sends a notification when users respond to a poll on the specified channel.
The channel.prediction.begin subscription type sends a notification when a Prediction begins on the specified channel.
The channel.prediction.end subscription type sends a notification when a Prediction ends on the specified channel.
The channel.prediction.lock subscription type sends a notification when a Prediction is locked on the specified channel.
The channel.prediction.progress subscription type sends a notification when users participate in a Prediction on the specified channel.
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Deprecated.
Friends are being removed by Twitch on 2022-05-25
Called when a user receives a gift from a Prime member.
Called when a user upgrades from a prime sub to a tiered subscription.
This event gets called when the bot gets a private message.
Additional information about a product acquired via a Twitch Extension Bits transaction.
Wrapper around a HTTP(S) proxy to be used by Twitch4J modules
Fired when a user access token had outstanding PubSub subscriptions, but was revoked.
PubSub Connection Event
PubSub Request
PubSub subscription.
Called when a channel cancels an outstanding raid.
This event gets called when a user receives a raid.
Called when a monetary event (e.g.
Deprecated.
no longer sent by twitch.
R9K State Event
Sends a notification when the broadcaster activates Shield Mode.
ShieldModeCondition.ShieldModeConditionBuilder<C extends ShieldModeCondition,B extends ShieldModeCondition.ShieldModeConditionBuilder<C,B>>
Sends a notification when the broadcaster deactivates Shield Mode.
Sends a notification when the specified broadcaster sends a Shoutout.
Sends a notification when the specified broadcaster receives a Shoutout.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Slow Mode State Event
A supplier that can sneakily throw exceptions.
The reasons for closing the eventsub websocket connection.
An object that identifies the message sent over EventSub Websockets.
An object that contains the EventSub Websocket message.
Stream (LiveStream)
Stream Keys
Stream List
Model representing the response for Create Stream Marker.
Model representing a stream.
Model representing a stream.
StreamOfflineCondition.StreamOfflineConditionBuilder<C extends StreamOfflineCondition,B extends StreamOfflineCondition.StreamOfflineConditionBuilder<C,B>>
The specified broadcaster stops a stream.
StreamOnlineCondition.StreamOnlineConditionBuilder<C extends StreamOnlineCondition,B extends StreamOnlineCondition.StreamOnlineConditionBuilder<C,B>>
The specified broadcaster starts a stream.
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
Deprecated.
Deprecated.
Twitch has deprecated UUID-based tags with the latest custom tags system.
Subscribers Only State Event
A pool of connections for making subscriptions (and potentially unsubscribing from later).
SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2 extends SubscriptionConnectionPool<C,S,T,U>,B extends SubscriptionConnectionPool.SubscriptionConnectionPoolBuilder<C,S,T,U,C2,B>>
This event gets called when a user gets a new subscriber or a user resubscribes.
The type of event in the event_data payload.
Deprecated.
Enumeric Twitch Subscription Plan
Enumeric Twitch Subscription Type
Fires when a chat message has been sent from a suspicious user.
Fires when a suspicious user's treatment has been updated.
The status change applied to the terms.
WebSocket - Connection State
Generic interface for objects that can respond to a subscription request, S,
with a response, T, which can later be used for unsubscription to yield U.
Twitch Chat
A pool for
TwitchChat connections.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>>
Utility class for retrieving standard rate limits for
TwitchChatBuilder to get a TwitchClient Instance by provided various options, to provide the user with a lot of customizable options.
A helper class that covers a few basic use cases of most library users
Injects ClientId Header, the User Agent and other common headers into each API Request
Builder to get a TwitchClientPool Instance by provided various options, to provide the user with a lot of customizable options.
Facilitates creating EventSub WebSocket shards for a new or existing Conduit.
Wrapper for a Twitch-specified enum where all of the possible values may not be documented.
A single EventSub websocket for a single user id.
A pool for EventSub websocket subscriptions across multiple users.
Deprecated.
the Extensions API traditionally uses the decommissioned Kraken API.
Deprecated.
the Extensions API traditionally uses the decommissioned Kraken API.
Injects Client-ID and User-Agent in each API request
Deprecated.
This is an unofficial API that is not intended for third-party use.
Twitch GraphQL Builder
Twitch - Helix API
Twitch API - Helix
Injects ClientId Header, the User Agent and other common headers into each API Request
Twitch Identity Provider
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
Deprecated.
Kraken is deprecated and has been shut down on Febuary 28, 2022.
This singleton facilitates sharing of key rate-limit buckets by user and limit type.
The types of rate-limits imposed by Twitch.
Deprecated.
All of these endpoints have been (or will be) decommissioned by Twitch.
Deprecated.
Adds common configuration options for subscription-based connection pools built around instances of T4J modules.
TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,C2 extends TwitchModuleConnectionPool<C,X,Y,Z,B>,B2 extends TwitchModuleConnectionPool.TwitchModuleConnectionPoolBuilder<C,X,Y,Z,B,C2,B2>>
Twitch PubSub
Twitch PubSub Builder
A pool for PubSub connections to help navigate rate-limits.
TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<C extends TwitchPubSubConnectionPool,B extends TwitchPubSubConnectionPool.TwitchPubSubConnectionPoolBuilder<C,B>>
A pool for a single user id to subscriptions spread over multiple EventSub websockets.
TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<C extends TwitchSingleUserEventSocketPool,B extends TwitchSingleUserEventSocketPool.TwitchSingleUserEventSocketPoolBuilder<C,B>>
Deprecated.
API Error: Unauthorized
Fires when a user creates an unban request.
Fires when an unban request has been resolved.
Annotates a method or features that uses unofficial api endpoints, those can break at any point in time.
Status code applied to a set of entitlements for the update operation that can be used to indicate partial success.
URLs to upload entitlements to
User
UserAuthorizationGrantCondition.UserAuthorizationGrantConditionBuilder<C extends UserAuthorizationGrantCondition,B extends UserAuthorizationGrantCondition.UserAuthorizationGrantConditionBuilder<C,B>>
A user has granted authorization for your client id.
UserAuthorizationRevokeCondition.UserAuthorizationRevokeConditionBuilder<C extends UserAuthorizationRevokeCondition,B extends UserAuthorizationRevokeCondition.UserAuthorizationRevokeConditionBuilder<C,B>>
A user has revoked authorization for your client id.
This event gets called when a user gets banned.
UserEventSubCondition.UserEventSubConditionBuilder<C extends UserEventSubCondition,B extends UserEventSubCondition.UserEventSubConditionBuilder<C,B>>
User List
Notifies a user if their message is caught by AutoMod.
Notifies a user if their message’s AutoMod status is updated.
Sent on prediction-made for predictions-user-v1
Sent on prediction-result for predictions-user-v1
Deprecated.
Friends are being removed by Twitch on 2022-05-25
This event gets called when a user joins a channel or sends a PRIVMSG to a channel.
Deprecated.
Twitch decommissioned this API; please migrate to EventSub
This event gets called when a user get a timeout.
UserUpdateCondition.UserUpdateConditionBuilder<C extends UserUpdateCondition,B extends UserUpdateCondition.UserUpdateConditionBuilder<C,B>>
A user has updated their account.
A generic container for helix responses that contain a single value.
Video
The order to sort the returned videos in.
A filter used to filter the list of videos by when they were published.
The video's type.
Video List
Model representing a stream.
Model representing a stream.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
The state of a
WebsocketConnection.Fires when anyone whispers the specified user.