eventsub/io.github.captnblubber.twitchkt.eventsub.model

Package-level declarations

Types

Link copied to clipboard
@Serializable
data class AnnouncementNotification(val color: String = "")
Link copied to clipboard
data class AutomodMessageHold(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val chatMessageId: String, val message: ChatMessage, val category: String, val level: Int, val heldAt: Instant, val fragments: List<MessageFragment>) : TwitchEvent

Twitch EventSub: automod.message.hold

Link copied to clipboard
data class AutomodMessageUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val chatMessageId: String, val message: ChatMessage, val category: String, val level: Int, val status: String, val heldAt: Instant, val fragments: List<MessageFragment>) : TwitchEvent

Twitch EventSub: automod.message.update

Link copied to clipboard
data class AutomodSettingsUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val overallLevel: Int?, val disability: Int, val aggression: Int, val sexualitySexOrGender: Int, val misogyny: Int, val bullying: Int, val swearing: Int, val raceEthnicityOrReligion: Int, val sexBasedTerms: Int) : TwitchEvent

Twitch EventSub: automod.settings.update

Link copied to clipboard
data class AutomodTermsUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val action: String, val fromAutomod: Boolean, val terms: List<String>) : TwitchEvent

Twitch EventSub: automod.terms.update

Link copied to clipboard
@Serializable
data class BitsBadgeTierNotification(val tier: Int = 0)
Link copied to clipboard
@Serializable
enum BitsUseType : Enum<BitsUseType>
Link copied to clipboard
data class ChannelAdBreakBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val durationSeconds: Int, val startedAt: Instant, val isAutomatic: Boolean, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val requesterUserId: String, val requesterUserLogin: String, val requesterUserName: String) : TwitchEvent

Twitch EventSub: channel.ad_break.begin

Link copied to clipboard
data class ChannelBan(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val reason: String, val bannedAt: Instant, val endsAt: Instant?, val isPermanent: Boolean) : TwitchEvent

Twitch EventSub: channel.ban

Link copied to clipboard
data class ChannelBitsUse(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val bits: Int, val type: BitsUseType, val powerUp: PowerUp?, val message: ChatMessage?) : TwitchEvent

Twitch EventSub: channel.bits.use

Link copied to clipboard
data class ChannelChatClear(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.chat.clear

Link copied to clipboard
data class ChannelChatClearUserMessages(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val targetUserId: String, val targetUserLogin: String, val targetUserName: String) : TwitchEvent

Twitch EventSub: channel.chat.clear_user_messages

Link copied to clipboard
data class ChannelChatMessage(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val chatterUserId: String, val chatterUserLogin: String, val chatterUserName: String, val chatMessageId: String, val message: ChatMessage, val color: String, val badges: List<ChatBadge>, val messageType: ChatMessageType, val cheer: ChatCheer?, val reply: ChatReply?, val channelPointsCustomRewardId: String?) : TwitchEvent

Twitch EventSub: channel.chat.message

Link copied to clipboard
data class ChannelChatMessageDelete(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val targetUserId: String, val targetUserLogin: String, val targetUserName: String, val targetMessageId: String) : TwitchEvent

Twitch EventSub: channel.chat.message_delete

Link copied to clipboard
data class ChannelChatNotification(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val chatterUserId: String, val chatterUserLogin: String, val chatterUserName: String, val noticeType: String, val message: ChatMessage, val sub: SubNotification?, val resub: ResubNotification?, val subGift: SubGiftNotification?, val communitySubGift: CommunitySubGiftNotification?, val giftPaidUpgrade: GiftPaidUpgradeNotification?, val primePaidUpgrade: PrimePaidUpgradeNotification?, val payItForward: PayItForwardNotification?, val raid: RaidNotification?, val unraid: JsonObject?, val announcement: AnnouncementNotification?, val bitsBadgeTier: BitsBadgeTierNotification?, val charityDonation: CharityDonationNotification?) : TwitchEvent

Twitch EventSub: channel.chat.notification

Link copied to clipboard
data class ChannelChatSettingsUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val emoteMode: Boolean, val followerMode: Boolean, val followerModeDurationMinutes: Int?, val slowMode: Boolean, val slowModeWaitTimeSeconds: Int?, val subscriberMode: Boolean, val uniqueChatMode: Boolean) : TwitchEvent

Twitch EventSub: channel.chat_settings.update

Link copied to clipboard
data class ChannelChatUserMessageHold(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val chatMessageId: String, val message: ChatMessage) : TwitchEvent

Twitch EventSub: channel.chat.user_message_hold

Link copied to clipboard
data class ChannelChatUserMessageUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val status: String, val chatMessageId: String, val message: ChatMessage) : TwitchEvent

Twitch EventSub: channel.chat.user_message_update

Link copied to clipboard
data class ChannelCheer(val subscriptionType: String, val messageId: String, val timestamp: Instant, val isAnonymous: Boolean, val userId: String?, val userLogin: String?, val userName: String?, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val message: String, val bits: Int) : TwitchEvent

Twitch EventSub: channel.cheer

Link copied to clipboard
data class ChannelFollow(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val followedAt: Instant) : TwitchEvent

Twitch EventSub: channel.follow

Link copied to clipboard
data class ChannelGoalBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val type: String, val description: String, val currentAmount: Int, val targetAmount: Int, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.goal.begin

Link copied to clipboard
data class ChannelGoalEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val type: String, val description: String, val isAchieved: Boolean, val currentAmount: Int, val targetAmount: Int, val startedAt: Instant, val endedAt: Instant) : TwitchEvent

Twitch EventSub: channel.goal.end

Link copied to clipboard
data class ChannelGoalProgress(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val type: String, val description: String, val currentAmount: Int, val targetAmount: Int, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.goal.progress

Link copied to clipboard
data class ChannelModerate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val action: String, val followers: ModFollowers? = null, val slow: ModSlow? = null, val vip: ModTargetUser? = null, val unvip: ModTargetUser? = null, val mod: ModTargetUser? = null, val unmod: ModTargetUser? = null, val ban: ModBan? = null, val unban: ModTargetUser? = null, val timeout: ModTimeout? = null, val untimeout: ModTargetUser? = null, val raid: ModRaid? = null, val unraid: ModTargetUser? = null, val delete: ModDelete? = null, val automodTerms: ModAutomodTerms? = null, val unmute: ModTargetUser? = null, val warn: ModWarn? = null, val shared: JsonObject? = null) : TwitchEvent

Twitch EventSub: channel.moderate

Link copied to clipboard
data class ChannelModeratorAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.moderator.add

Link copied to clipboard
data class ChannelModeratorRemove(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.moderator.remove

Link copied to clipboard
data class ChannelPointsAutomaticRedemptionAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val id: String, val reward: ChannelPointsReward, val message: ChatMessage?, val userInput: String?, val redeemedAt: Instant) : TwitchEvent

Twitch EventSub: channel.channel_points_automatic_reward_redemption.add

Link copied to clipboard
data class ChannelPointsCustomRewardAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val isEnabled: Boolean, val isPaused: Boolean, val isInStock: Boolean, val title: String, val cost: Int, val prompt: String, val isUserInputRequired: Boolean, val shouldRedemptionsSkipRequestQueue: Boolean, val maxPerStream: MaxPerStreamSetting, val maxPerUserPerStream: MaxPerStreamSetting, val backgroundColor: String, val image: RewardImage?, val defaultImage: RewardImage, val globalCooldown: GlobalCooldownSetting, val cooldownExpiresAt: Instant?, val redemptionsRedeemedCurrentStream: Int?) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward.add

Link copied to clipboard
data class ChannelPointsCustomRewardRemove(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val isEnabled: Boolean, val isPaused: Boolean, val isInStock: Boolean, val title: String, val cost: Int, val prompt: String, val isUserInputRequired: Boolean, val shouldRedemptionsSkipRequestQueue: Boolean, val maxPerStream: MaxPerStreamSetting, val maxPerUserPerStream: MaxPerStreamSetting, val backgroundColor: String, val image: RewardImage?, val defaultImage: RewardImage, val globalCooldown: GlobalCooldownSetting, val cooldownExpiresAt: Instant?, val redemptionsRedeemedCurrentStream: Int?) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward.remove

Link copied to clipboard
data class ChannelPointsCustomRewardUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val isEnabled: Boolean, val isPaused: Boolean, val isInStock: Boolean, val title: String, val cost: Int, val prompt: String, val isUserInputRequired: Boolean, val shouldRedemptionsSkipRequestQueue: Boolean, val maxPerStream: MaxPerStreamSetting, val maxPerUserPerStream: MaxPerStreamSetting, val backgroundColor: String, val image: RewardImage?, val defaultImage: RewardImage, val globalCooldown: GlobalCooldownSetting, val cooldownExpiresAt: Instant?, val redemptionsRedeemedCurrentStream: Int?) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward.update

Link copied to clipboard
data class ChannelPointsRedemptionAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val userInput: String, val status: String, val reward: ChannelPointsReward, val redeemedAt: Instant) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward_redemption.add

Link copied to clipboard
data class ChannelPointsRedemptionUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val userInput: String, val status: String, val reward: ChannelPointsReward, val redeemedAt: Instant) : TwitchEvent

Twitch EventSub: channel.channel_points_custom_reward_redemption.update

Link copied to clipboard
@Serializable
data class ChannelPointsReward(val id: String = "", val title: String = "", val cost: Int = 0, val prompt: String = "")
Link copied to clipboard
data class ChannelRaid(val subscriptionType: String, val messageId: String, val timestamp: Instant, val fromBroadcasterUserId: String, val fromBroadcasterUserLogin: String, val fromBroadcasterUserName: String, val toBroadcasterUserId: String, val toBroadcasterUserLogin: String, val toBroadcasterUserName: String, val viewers: Int) : TwitchEvent

Twitch EventSub: channel.raid

Link copied to clipboard
data class ChannelSharedChatBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val sessionId: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val hostBroadcasterUserId: String, val hostBroadcasterUserLogin: String, val hostBroadcasterUserName: String, val participants: List<SharedChatParticipant>) : TwitchEvent

Twitch EventSub: channel.shared_chat.begin

Link copied to clipboard
data class ChannelSharedChatEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val sessionId: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val hostBroadcasterUserId: String, val hostBroadcasterUserLogin: String, val hostBroadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.shared_chat.end

Link copied to clipboard
data class ChannelSharedChatUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val sessionId: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val hostBroadcasterUserId: String, val hostBroadcasterUserLogin: String, val hostBroadcasterUserName: String, val participants: List<SharedChatParticipant>) : TwitchEvent

Twitch EventSub: channel.shared_chat.update

Link copied to clipboard
data class ChannelShieldModeBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.shield_mode.begin

Link copied to clipboard
data class ChannelShieldModeEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val endedAt: Instant) : TwitchEvent

Twitch EventSub: channel.shield_mode.end

Link copied to clipboard
data class ChannelShoutoutCreate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val toBroadcasterUserId: String, val toBroadcasterUserLogin: String, val toBroadcasterUserName: String, val viewerCount: Int, val startedAt: Instant, val cooldownEndsAt: Instant, val targetCooldownEndsAt: Instant) : TwitchEvent

Twitch EventSub: channel.shoutout.create

Link copied to clipboard
data class ChannelShoutoutReceive(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val fromBroadcasterUserId: String, val fromBroadcasterUserLogin: String, val fromBroadcasterUserName: String, val viewerCount: Int, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.shoutout.receive

Link copied to clipboard
data class ChannelSubscribe(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val tier: String, val isGift: Boolean) : TwitchEvent

Twitch EventSub: channel.subscribe

Link copied to clipboard
data class ChannelSubscriptionEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val tier: String, val isGift: Boolean) : TwitchEvent

Twitch EventSub: channel.subscription.end

Link copied to clipboard
data class ChannelSubscriptionGift(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String?, val userLogin: String?, val userName: String?, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val total: Int, val tier: String, val cumulativeTotal: Int?, val isAnonymous: Boolean) : TwitchEvent

Twitch EventSub: channel.subscription.gift

Link copied to clipboard
data class ChannelSubscriptionMessage(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val tier: String, val message: ChatMessage, val cumulativeMonths: Int, val streakMonths: Int?, val durationMonths: Int) : TwitchEvent

Twitch EventSub: channel.subscription.message

Link copied to clipboard
data class ChannelSuspiciousUserMessage(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val lowTrustStatus: String, val sharedBanChannelIds: List<String>, val types: List<String>, val bannedChannelCount: Int, val message: ChatMessage) : TwitchEvent

Twitch EventSub: channel.suspicious_user.message

Link copied to clipboard
data class ChannelSuspiciousUserUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val userId: String, val userLogin: String, val userName: String, val lowTrustStatus: String) : TwitchEvent

Twitch EventSub: channel.suspicious_user.update

Link copied to clipboard
data class ChannelUnban(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String) : TwitchEvent

Twitch EventSub: channel.unban

Link copied to clipboard
data class ChannelUnbanRequestCreate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val text: String, val createdAt: Instant) : TwitchEvent

Twitch EventSub: channel.unban_request.create

Link copied to clipboard
data class ChannelUnbanRequestResolve(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val userId: String, val userLogin: String, val userName: String, val resolutionText: String?, val status: String) : TwitchEvent

Twitch EventSub: channel.unban_request.resolve

Link copied to clipboard
data class ChannelUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val language: String, val categoryId: String, val categoryName: String, val contentClassificationLabels: List<String>) : TwitchEvent

Twitch EventSub: channel.update

Link copied to clipboard
data class ChannelVipAdd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.vip.add

Link copied to clipboard
data class ChannelVipRemove(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: channel.vip.remove

Link copied to clipboard
data class ChannelWarningAcknowledge(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String) : TwitchEvent

Twitch EventSub: channel.warning.acknowledge

Link copied to clipboard
data class ChannelWarningSend(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val moderatorUserId: String, val moderatorUserLogin: String, val moderatorUserName: String, val userId: String, val userLogin: String, val userName: String, val reason: String?, val chatRulesCited: List<String>?) : TwitchEvent

Twitch EventSub: channel.warning.send

Link copied to clipboard
data class CharityCampaignProgress(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val charityName: String, val charityDescription: String, val charityLogo: String, val charityWebsite: String, val currentAmount: CurrencyAmount, val targetAmount: CurrencyAmount) : TwitchEvent

Twitch EventSub: channel.charity_campaign.progress

Link copied to clipboard
data class CharityCampaignStart(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val charityName: String, val charityDescription: String, val charityLogo: String, val charityWebsite: String, val currentAmount: CurrencyAmount, val targetAmount: CurrencyAmount, val startedAt: Instant) : TwitchEvent

Twitch EventSub: channel.charity_campaign.start

Link copied to clipboard
data class CharityCampaignStop(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val charityName: String, val charityDescription: String, val charityLogo: String, val charityWebsite: String, val currentAmount: CurrencyAmount, val targetAmount: CurrencyAmount, val stoppedAt: Instant) : TwitchEvent

Twitch EventSub: channel.charity_campaign.stop

Link copied to clipboard
data class CharityDonate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val campaignId: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val charityName: String, val charityDescription: String, val charityLogo: String, val charityWebsite: String, val amount: CurrencyAmount) : TwitchEvent

Twitch EventSub: channel.charity_campaign.donate

Link copied to clipboard
@Serializable
data class CharityDonationNotification(val charityName: String = "", val amount: CurrencyAmount = CurrencyAmount())
Link copied to clipboard
@Serializable
data class ChatBadge(val setId: String = "", val id: String = "", val info: String = "")
Link copied to clipboard
@Serializable
data class ChatCheer(val bits: Int = 0)
Link copied to clipboard
@Serializable
data class ChatMessage(val text: String = "", val fragments: List<MessageFragment> = emptyList())
Link copied to clipboard
@Serializable
enum ChatMessageType : Enum<ChatMessageType>
Link copied to clipboard
@Serializable
data class ChatReply(val parentMessageId: String = "", val parentMessageBody: String = "", val parentUserId: String = "", val parentUserName: String = "", val parentUserLogin: String = "", val threadMessageId: String = "", val threadUserId: String = "", val threadUserName: String = "", val threadUserLogin: String = "")
Link copied to clipboard
@Serializable
data class Cheermote(val prefix: String = "", val bits: Int = 0, val tier: Int = 0)
Link copied to clipboard
@Serializable
data class CommunitySubGiftNotification(val id: String = "", val total: Int = 0, val subTier: String = "", val cumulativeTotal: Int? = null)
Link copied to clipboard
data class ConduitShardDisabled(val subscriptionType: String, val messageId: String, val timestamp: Instant, val conduitId: String, val shardId: String, val status: String, val transport: ConduitTransport) : TwitchEvent

Twitch EventSub: conduit.shard.disabled

Link copied to clipboard
@Serializable
data class ConduitTransport(val method: String = "", val callback: String? = null, val sessionId: String? = null, val connectedAt: Instant? = null, val disconnectedAt: Instant? = null)
Link copied to clipboard
@Serializable
data class CurrencyAmount(val value: Int = 0, val decimalPlaces: Int = 0, val currency: String = "")
Link copied to clipboard
@Serializable
data class Emote(val id: String = "", val emoteSetId: String = "", val ownerId: String? = null, val format: List<String> = emptyList())
Link copied to clipboard
data class ExtensionBitsTransactionCreate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val extensionClientId: String, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val userId: String, val userLogin: String, val userName: String, val product: ExtensionProduct) : TwitchEvent

Twitch EventSub: extension.bits_transaction.create

Link copied to clipboard
@Serializable
data class ExtensionProduct(val name: String = "", val sku: String = "", val bits: Int = 0, val inDevelopment: Boolean = false)
Link copied to clipboard
@Serializable
enum FragmentType : Enum<FragmentType>
Link copied to clipboard
@Serializable
data class GiftPaidUpgradeNotification(val gifterIsAnonymous: Boolean = false, val gifterUserId: String? = null, val gifterUserName: String? = null, val gifterUserLogin: String? = null)
Link copied to clipboard
@Serializable
data class GlobalCooldownSetting(val isEnabled: Boolean = false, val seconds: Int = 0)
Link copied to clipboard
data class HypeTrainBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val total: Int, val progress: Int, val goal: Int, val topContributions: List<HypeTrainContribution>, val lastContribution: HypeTrainContribution?, val level: Int, val startedAt: Instant, val expiresAt: Instant, val isGoldenKappaTrain: Boolean = false, val allTimeHighLevel: Int = 0, val allTimeHighTotal: Int = 0) : TwitchEvent

Twitch EventSub: channel.hype_train.begin v2

Link copied to clipboard
@Serializable
data class HypeTrainContribution(val userId: String = "", val userLogin: String = "", val userName: String = "", val type: String = "", val total: Int = 0)
Link copied to clipboard
data class HypeTrainEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val level: Int, val total: Int, val topContributions: List<HypeTrainContribution>, val startedAt: Instant, val endedAt: Instant, val cooldownEndsAt: Instant, val isGoldenKappaTrain: Boolean = false) : TwitchEvent

Twitch EventSub: channel.hype_train.end v2

Link copied to clipboard
data class HypeTrainProgress(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val total: Int, val progress: Int, val goal: Int, val topContributions: List<HypeTrainContribution>, val lastContribution: HypeTrainContribution?, val level: Int, val startedAt: Instant, val expiresAt: Instant, val isGoldenKappaTrain: Boolean = false) : TwitchEvent

Twitch EventSub: channel.hype_train.progress v2

Link copied to clipboard
@Serializable
data class MaxPerStreamSetting(val isEnabled: Boolean = false, val value: Int = 0)
Link copied to clipboard
@Serializable
data class Mention(val userId: String = "", val userLogin: String = "", val userName: String = "")
Link copied to clipboard
@Serializable
data class MessageFragment(val type: FragmentType = FragmentType.TEXT, val text: String = "", val cheermote: Cheermote? = null, val emote: Emote? = null, val mention: Mention? = null)
Link copied to clipboard
@Serializable
data class ModAutomodTerms(val action: String = "", val list: String = "", val terms: List<String> = emptyList(), val fromAutomod: Boolean = false)
Link copied to clipboard
@Serializable
data class ModBan(val userId: String = "", val userLogin: String = "", val userName: String = "", val reason: String = "")
Link copied to clipboard
@Serializable
data class ModDelete(val userId: String = "", val userLogin: String = "", val userName: String = "", val messageId: String = "", val messageBody: String = "")
Link copied to clipboard
@Serializable
data class ModFollowers(val followDurationMinutes: Int = 0)
Link copied to clipboard
@Serializable
data class ModRaid(val userId: String = "", val userLogin: String = "", val userName: String = "", val viewerCount: Int = 0)
Link copied to clipboard
@Serializable
data class ModSlow(val waitTimeSeconds: Int = 0)
Link copied to clipboard
@Serializable
data class ModTargetUser(val userId: String = "", val userLogin: String = "", val userName: String = "")
Link copied to clipboard
@Serializable
data class ModTimeout(val userId: String = "", val userLogin: String = "", val userName: String = "", val reason: String = "", val expiresAt: Instant? = null)
Link copied to clipboard
@Serializable
data class ModWarn(val userId: String = "", val userLogin: String = "", val userName: String = "", val reason: String? = null, val chatRulesCited: List<String>? = null)
Link copied to clipboard
@Serializable
data class PayItForwardNotification(val gifterIsAnonymous: Boolean = false, val gifterUserId: String? = null, val gifterUserName: String? = null, val gifterUserLogin: String? = null)
Link copied to clipboard
data class PollBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val choices: List<PollChoice>, val bitsVoting: VotingSettings, val channelPointsVoting: VotingSettings, val startedAt: Instant, val endsAt: Instant) : TwitchEvent

Twitch EventSub: channel.poll.begin

Link copied to clipboard
@Serializable
data class PollChoice(val id: String = "", val title: String = "", val bitsVotes: Int = 0, val channelPointsVotes: Int = 0, val votes: Int = 0)
Link copied to clipboard
data class PollEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val choices: List<PollChoice>, val bitsVoting: VotingSettings, val channelPointsVoting: VotingSettings, val status: String, val startedAt: Instant, val endedAt: Instant) : TwitchEvent

Twitch EventSub: channel.poll.end

Link copied to clipboard
data class PollProgress(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val choices: List<PollChoice>, val bitsVoting: VotingSettings, val channelPointsVoting: VotingSettings, val startedAt: Instant, val endsAt: Instant) : TwitchEvent

Twitch EventSub: channel.poll.progress

Link copied to clipboard
@Serializable
data class PowerUp(val type: String = "", val emote: PowerUpEmote? = null)
Link copied to clipboard
@Serializable
data class PowerUpEmote(val id: String = "", val setId: String = "")
Link copied to clipboard
data class PredictionBegin(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val outcomes: List<PredictionOutcome>, val startedAt: Instant, val locksAt: Instant) : TwitchEvent

Twitch EventSub: channel.prediction.begin

Link copied to clipboard
data class PredictionEnd(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val winningOutcomeId: String?, val outcomes: List<PredictionOutcome>, val status: String, val startedAt: Instant, val endedAt: Instant) : TwitchEvent

Twitch EventSub: channel.prediction.end

Link copied to clipboard
data class PredictionLock(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val outcomes: List<PredictionOutcome>, val startedAt: Instant, val lockedAt: Instant) : TwitchEvent

Twitch EventSub: channel.prediction.lock

Link copied to clipboard
@Serializable
data class PredictionOutcome(val id: String = "", val title: String = "", val color: String = "", val users: Int = 0, val channelPoints: Int = 0, val topPredictors: List<TopPredictor>? = null)
Link copied to clipboard
data class PredictionProgress(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val title: String, val outcomes: List<PredictionOutcome>, val startedAt: Instant, val locksAt: Instant) : TwitchEvent

Twitch EventSub: channel.prediction.progress

Link copied to clipboard
@Serializable
data class PrimePaidUpgradeNotification(val subTier: String = "")
Link copied to clipboard
@Serializable
data class RaidNotification(val userId: String = "", val userLogin: String = "", val userName: String = "", val viewerCount: Int = 0)
Link copied to clipboard
@Serializable
data class ResubNotification(val cumulativeMonths: Int = 0, val durationMonths: Int = 0, val streakMonths: Int = 0, val subTier: String = "", val isPrime: Boolean = false, val isGift: Boolean = false, val gifterIsAnonymous: Boolean? = null, val gifterUserId: String? = null, val gifterUserName: String? = null, val gifterUserLogin: String? = null)
Link copied to clipboard
@Serializable
data class RewardImage(val url1x: String = "", val url2x: String = "", val url4x: String = "")
Link copied to clipboard
@Serializable
data class SharedChatParticipant(val broadcasterUserId: String = "", val broadcasterUserLogin: String = "", val broadcasterUserName: String = "")
Link copied to clipboard
data class StreamOffline(val subscriptionType: String, val messageId: String, val timestamp: Instant, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String) : TwitchEvent

Twitch EventSub: stream.offline

Link copied to clipboard
data class StreamOnline(val subscriptionType: String, val messageId: String, val timestamp: Instant, val id: String, val broadcasterUserId: String, val broadcasterUserLogin: String, val broadcasterUserName: String, val type: String, val startedAt: Instant) : TwitchEvent

Twitch EventSub: stream.online

Link copied to clipboard
@Serializable
data class SubGiftNotification(val durationMonths: Int = 0, val cumulativeTotal: Int? = null, val recipientUserId: String = "", val recipientUserName: String = "", val recipientUserLogin: String = "", val subTier: String = "", val communityGiftId: String? = null)
Link copied to clipboard
@Serializable
data class SubNotification(val subTier: String = "", val isPrime: Boolean = false, val durationMonths: Int = 0)
Link copied to clipboard
@Serializable
data class TopPredictor(val userId: String = "", val userLogin: String = "", val userName: String = "", val channelPointsWon: Int? = null, val channelPointsUsed: Int = 0)
Link copied to clipboard
sealed interface TwitchEvent

Base interface for all EventSub event types.

Link copied to clipboard
data class UnknownEvent(val subscriptionType: String, val messageId: String, val timestamp: Instant, val rawPayload: JsonObject) : TwitchEvent
Link copied to clipboard
data class UserAuthorizationGrant(val subscriptionType: String, val messageId: String, val timestamp: Instant, val clientId: String, val userId: String, val userLogin: String, val userName: String) : TwitchEvent

Twitch EventSub: user.authorization.grant

Link copied to clipboard
data class UserAuthorizationRevoke(val subscriptionType: String, val messageId: String, val timestamp: Instant, val clientId: String, val userId: String?, val userLogin: String?, val userName: String?) : TwitchEvent

Twitch EventSub: user.authorization.revoke

Link copied to clipboard
data class UserUpdate(val subscriptionType: String, val messageId: String, val timestamp: Instant, val userId: String, val userLogin: String, val userName: String, val email: String?, val emailVerified: Boolean, val description: String) : TwitchEvent

Twitch EventSub: user.update

Link copied to clipboard
@Serializable
data class VotingSettings(val isEnabled: Boolean = false, val amountPerVote: Int = 0)
Generated by Dokka
© 2026 Copyright