Enums and Payloads

Attributes
class twitchio.eventsub.SubscriptionType

An enum of available EventSub subscription types.

The value of each enum attribute will be the formal name sent and received to/from Twitch.

E.g. AutomodMessageHold -> "automod.message.hold".

AutomodMessageHold
Type

Literal[“automod.message.hold”]

AutomodMessageUpdate
Type

Literal[“automod.message.update”]

AutomodSettingsUpdate
Type

Literal[“automod.settings.update”]

AutomodTermsUpdate
Type

Literal[“automod.terms.update”]

ChannelUpdate
Type

Literal[“channel.update”]

ChannelFollow
Type

Literal[“channel.follow”]

ChannelAdBreakBegin
Type

Literal[“channel.ad_break.begin”]

ChannelBitsUseSubscription
Type

Literal[“channel.bits.use”]

ChannelChatClear
Type

Literal[“channel.chat.clear”]

ChannelChatClearUserMessages
Type

Literal[“channel.chat.clear_user_messages”]

ChannelChatMessage
Type

Literal[“channel.chat.message”]

ChannelChatMessageDelete
Type

Literal[“channel.chat.message_delete”]

ChannelChatNotification
Type

Literal[“channel.chat.notification”]

ChannelChatSettingsUpdate
Type

Literal[“channel.chat_settings.update”]

ChannelChatUserMessageHold
Type

Literal[“channel.chat.user_message_hold”]

ChannelChatUserMessageUpdate
Type

Literal[“channel.chat.user_message_update”]

ChannelSharedChatBegin
Type

Literal[“channel.shared_chat.begin”]

ChannelSharedChatUpdate
Type

Literal[“channel.shared_chat.update”]

ChannelSharedChatEnd
Type

Literal[“channel.shared_chat.end”]

ChannelSubscribe
Type

Literal[“channel.subscribe”]

ChannelSubscriptionEnd
Type

Literal[“channel.subscription.end”]

ChannelSubscriptionGift
Type

Literal[“channel.subscription.gift”]

ChannelSubscriptionMessage
Type

Literal[“channel.subscription.message”]

ChannelCheer
Type

Literal[“channel.cheer”]

ChannelRaid
Type

Literal[“channel.raid”]

ChannelBan
Type

Literal[“channel.ban”]

ChannelUnban
Type

Literal[“channel.unban”]

ChannelUnbanRequestCreate
Type

Literal[“channel.unban_request.create”]

ChannelUnbanRequestResolve
Type

Literal[“channel.unban_request.resolve”]

ChannelModerate
Type

Literal[“channel.moderate”]

ChannelModeratorAdd
Type

Literal[“channel.moderator.add”]

ChannelModeratorRemove
Type

Literal[“channel.moderator.remove”]

ChannelGuestStarSessionBegin
Type

Literal[“channel.guest_star_session.begin”]

ChannelGuestStarSessionEnd
Type

Literal[“channel.guest_star_session.end”]

ChannelGuestStarGuestUpdate
Type

Literal[“channel.guest_star_guest.update”]

ChannelGuestStarSettingsUpdate
Type

Literal[“channel.guest_star_settings.update”]

ChannelChannelPointsAutomaticRewardRedemptionAdd
Type

Literal[“channel.channel_points_automatic_reward_redemption.add”]

ChannelChannelPointsCustomRewardAdd
Type

Literal[“channel.channel_points_custom_reward.add”]

ChannelChannelPointsCustomRewardUpdate
Type

Literal[“channel.channel_points_custom_reward.update”]

ChannelChannelPointsCustomRewardRemove
Type

Literal[“channel.channel_points_custom_reward.remove”]

ChannelChannelPointsCustomRewardRedemptionAdd
Type

Literal[“channel.channel_points_custom_reward_redemption.add”]

ChannelChannelPointsCustomRewardRedemptionUpdate
Type

Literal[“channel.channel_points_custom_reward_redemption.update”]

ChannelPollBegin
Type

Literal[“channel.poll.begin”]

ChannelPollProgres
Type

Literal[“channel.poll.progress”]

ChannelPollEnd
Type

Literal[“channel.poll.end”]

ChannelPredictionBegin
Type

Literal[“channel.prediction.begin”]

ChannelPredictionProgres
Type

Literal[“channel.prediction.progress”]

ChannelPredictionLock
Type

Literal[“channel.prediction.lock”]

ChannelPredictionEnd
Type

Literal[“channel.prediction.end”]

ChannelSuspiciousUserMessage
Type

Literal[“channel.suspicious_user.message”]

ChannelSuspiciousUserUpdate
Type

Literal[“channel.suspicious_user.update”]

ChannelVipAdd
Type

Literal[“channel.vip.add”]

ChannelVipRemove
Type

Literal[“channel.vip.remove”]

ChannelCharityCampaignDonate
Type

Literal[“channel.charity_campaign.donate”]

ChannelCharityCampaignStart
Type

Literal[“channel.charity_campaign.start”]

ChannelCharityCampaignProgress
Type

Literal[“channel.charity_campaign.progress”]

ChannelCharityCampaignStop
Type

Literal[“channel.charity_campaign.stop”]

ConduitShardDisabled
Type

Literal[“conduit.shard.disabled”]

DropEntitlementGrant
Type

Literal[“drop.entitlement.grant”]

ExtensionBitsTransactionCreate
Type

Literal[“extension.bits_transaction.create”]

ChannelGoalBegin
Type

Literal[“channel.goal.begin”]

ChannelGoalProgress
Type

Literal[“channel.goal.progress”]

ChannelGoalEnd
Type

Literal[“channel.goal.end”]

ChannelHypeTrainBegin
Type

Literal[“channel.hype_train.begin”]

ChannelHypeTrainProgress
Type

Literal[“channel.hype_train.progress”]

ChannelHypeTrainEnd
Type

Literal[“channel.hype_train.end”]

ChannelShieldModeBegin
Type

Literal[“channel.shield_mode.begin”]

ChannelShieldModeEnd
Type

Literal[“channel.shield_mode.end”]

ChannelShoutoutCreate
Type

Literal[“channel.shoutout.create”]

ChannelShoutoutReceive
Type

Literal[“channel.shoutout.receive”]

ChannelWarningAcknowledgement
Type

Literal[“channel.warning.acknowledge”]

ChannelWarningSend
Type

Literal[“channel.warning.send”]

StreamOnline
Type

Literal[“stream.online”]

StreamOffline
Type

Literal[“stream.offline”]

UserAuthorizationGrant
Type

Literal[“user.authorization.grant”]

UserAuthorizationRevoke
Type

Literal[“user.authorization.revoke”]

UserUpdate
Type

Literal[“user.update”]

UserWhisperMessage
Type

Literal[“user.whisper.message”]

Attributes
class twitchio.eventsub.TransportMethod

An enum of EventSub transports.

WEBHOOK
Type

Literal[“webhook”]

WEBSOCKET
Type

Literal[“websocket]

CONDUIT
Type

Literal[“conduit”]

Websocket Subscription Data

Attributes
class twitchio.WebsocketSubscriptionData

Payload returned from websocket_subscriptions() and delete_websocket_subscription() containing relevant information about the websocket subscription.

raw_data

The data contained in this class as a dict

Type

dict[str, Any]

condition

The condition used to subscribe to the subscription as a dict.

Type

dict[str, str]

token_for

The User ID used to subscribe to this subscription. This could be the Client Users ID.

Type

str

transport

The TransportMethod enum. This will always be WEBSOCKET.

Type

TransportMethod

type

The subscription type as an enum value.

Type

SubscriptionType

version

The version of the subscription on twitch.

Type

str