|
5 | 5 | Events Reference
|
6 | 6 | ################
|
7 | 7 |
|
| 8 | +All events are prefixed with **event_** |
| 9 | + |
| 10 | +.. list-table:: |
| 11 | + :header-rows: 1 |
| 12 | + |
| 13 | + * - Type |
| 14 | + - Subscription |
| 15 | + - Event |
| 16 | + * - Automod Message Hold |
| 17 | + - AutomodMessageHoldSubscription |
| 18 | + - automod_message_hold |
| 19 | + * - Automod Message Update |
| 20 | + - AutomodMessageUpdateSubscription |
| 21 | + - automod_message_update |
| 22 | + * - Automod Settings Update |
| 23 | + - AutomodSettingsUpdateSubscription |
| 24 | + - automod_settings_update |
| 25 | + * - Automod Terms Update |
| 26 | + - AutomodTermsUpdateSubscription |
| 27 | + - automod_terms_update |
| 28 | + * - Channel Update |
| 29 | + - ChannelUpdateSubscription |
| 30 | + - channel_update |
| 31 | + * - Channel Follow |
| 32 | + - ChannelFollowSubscription |
| 33 | + - follow |
| 34 | + * - Channel Ad Break Begin |
| 35 | + - AdBreakBeginSubscription |
| 36 | + - ad_break |
| 37 | + * - Channel Chat Clear |
| 38 | + - ChatClearSubscription |
| 39 | + - chat_clear |
| 40 | + * - Channel Chat Clear User Messages |
| 41 | + - ChatClearUserMessagesSubscription |
| 42 | + - chat_clear_user |
| 43 | + * - Channel Chat Message |
| 44 | + - ChatMessageSubscription |
| 45 | + - message |
| 46 | + * - Channel Chat Message Delete |
| 47 | + - ChatNotificationSubscription |
| 48 | + - message_delete |
| 49 | + * - Channel Chat Notification |
| 50 | + - ChatMessageDeleteSubscription |
| 51 | + - chat_notification |
| 52 | + * - Channel Chat Settings Update |
| 53 | + - ChatSettingsUpdateSubscription |
| 54 | + - chat_settings_update |
| 55 | + * - Channel Chat User Message Hold |
| 56 | + - ChatUserMessageHoldSubscription |
| 57 | + - chat_user_message_hold |
| 58 | + * - Channel Chat User Message Update |
| 59 | + - ChatUserMessageUpdateSubscription |
| 60 | + - chat_user_message_update |
| 61 | + * - Channel Shared Chat Session Begin |
| 62 | + - SharedChatSessionBeginSubscription |
| 63 | + - shared_chat_begin |
| 64 | + * - Channel Shared Chat Session Update |
| 65 | + - SharedChatSessionUpdateSubscription |
| 66 | + - shared_chat_update |
| 67 | + * - Channel Shared Chat Session End |
| 68 | + - SharedChatSessionEndSubscription |
| 69 | + - shared_chat_end |
| 70 | + * - Channel Subscribe |
| 71 | + - ChannelSubscribeSubscription |
| 72 | + - subscription |
| 73 | + * - Channel Subscription End |
| 74 | + - ChannelSubscriptionEndSubscription |
| 75 | + - subscription_end |
| 76 | + * - Channel Subscription Gift |
| 77 | + - ChannelSubscriptionGiftSubscription |
| 78 | + - subscription_gift |
| 79 | + * - Channel Subscription Message |
| 80 | + - ChannelSubscribeMessageSubscription |
| 81 | + - subscription_message |
| 82 | + * - Channel Cheer |
| 83 | + - ChannelCheerSubscription |
| 84 | + - cheer |
| 85 | + * - Channel Raid |
| 86 | + - ChannelRaidSubscription |
| 87 | + - raid |
| 88 | + * - Channel Ban |
| 89 | + - ChannelBanSubscription |
| 90 | + - ban |
| 91 | + * - Channel Unban |
| 92 | + - ChannelUnbanSubscription |
| 93 | + - unban |
| 94 | + * - Channel Unban Request Create |
| 95 | + - ChannelUnbanRequestSubscription |
| 96 | + - unban_request |
| 97 | + * - Channel Unban Request Resolve |
| 98 | + - ChannelUnbanRequestResolveSubscription |
| 99 | + - unban_request_resolve |
| 100 | + * - Channel Moderate |
| 101 | + - ChannelModerateSubscription |
| 102 | + - mod_action |
| 103 | + * - Channel Moderate V2 |
| 104 | + - ChannelModerateV2Subscription |
| 105 | + - mod_action |
| 106 | + * - Channel Moderator Add |
| 107 | + - ChannelModeratorAddSubscription |
| 108 | + - moderator_add |
| 109 | + * - Channel Moderator Remove |
| 110 | + - ChannelModeratorRemoveSubscription |
| 111 | + - moderator_remove |
| 112 | + * - Channel Points Automatic Reward Redemption |
| 113 | + - ChannelPointsAutoRedeemSubscription |
| 114 | + - automatic_redemption_add |
| 115 | + * - Channel Points Custom Reward Add |
| 116 | + - ChannelPointsRewardAddSubscription |
| 117 | + - custom_reward_add |
| 118 | + * - Channel Points Custom Reward Update |
| 119 | + - ChannelPointsRewardUpdateSubscription |
| 120 | + - custom_reward_update |
| 121 | + * - Channel Points Custom Reward Remove |
| 122 | + - ChannelPointsRewardRemoveSubscription |
| 123 | + - custom_reward_remove |
| 124 | + * - Channel Points Custom Reward Redemption Add |
| 125 | + - ChannelPointsRedeemAddSubscription |
| 126 | + - custom_redemption_add |
| 127 | + * - Channel Points Custom Reward Redemption Update |
| 128 | + - ChannelPointsRedeemUpdateSubscription |
| 129 | + - custom_redemption_update |
| 130 | + * - Channel Poll Begin |
| 131 | + - ChannelPollBeginSubscription |
| 132 | + - poll_begin |
| 133 | + * - Channel Poll Progress |
| 134 | + - ChannelPollProgressSubscription |
| 135 | + - poll_progress |
| 136 | + * - Channel Poll End |
| 137 | + - ChannelPollEndSubscription |
| 138 | + - poll_end |
| 139 | + * - Channel Prediction Begin |
| 140 | + - ChannelPredictionBeginSubscription |
| 141 | + - prediction_begin |
| 142 | + * - Channel Prediction Progress |
| 143 | + - ChannelPredictionProgressSubscription |
| 144 | + - prediction_progress |
| 145 | + * - Channel Prediction Lock |
| 146 | + - ChannelPredictionLockSubscription |
| 147 | + - prediction_lock |
| 148 | + * - Channel Prediction End |
| 149 | + - ChannelPredictionEndSubscription |
| 150 | + - prediction_end |
| 151 | + * - Channel Suspicious User Message |
| 152 | + - SuspiciousUserMessageSubscription |
| 153 | + - suspicious_user_message |
| 154 | + * - Channel Suspicious User Update |
| 155 | + - SuspiciousUserUpdateSubscription |
| 156 | + - suspicious_user_update |
| 157 | + * - Channel VIP Add |
| 158 | + - ChannelVIPAddSubscription |
| 159 | + - vip_add |
| 160 | + * - Channel VIP Remove |
| 161 | + - ChannelVIPRemoveSubscription |
| 162 | + - vip_remove |
| 163 | + * - Channel Warning Acknowledgement |
| 164 | + - ChannelWarningAcknowledgementSubscription |
| 165 | + - warning_acknowledge |
| 166 | + * - Channel Warning Send |
| 167 | + - ChannelWarningSendSubscription |
| 168 | + - warning_send |
| 169 | + * - Charity Donation |
| 170 | + - CharityDonationSubscription |
| 171 | + - charity_campaign_donate |
| 172 | + * - Charity Campaign Start |
| 173 | + - CharityCampaignStartSubscription |
| 174 | + - charity_campaign_start |
| 175 | + * - Charity Campaign Progress |
| 176 | + - CharityCampaignProgressSubscription |
| 177 | + - charity_campaign_progress |
| 178 | + * - Charity Campaign Stop |
| 179 | + - CharityCampaignStopSubscription |
| 180 | + - charity_campaign_stop |
| 181 | + * - Goal Begin |
| 182 | + - GoalBeginSubscription |
| 183 | + - goal_begin |
| 184 | + * - Goal Progress |
| 185 | + - GoalProgressSubscription |
| 186 | + - goal_progress |
| 187 | + * - Goal End |
| 188 | + - GoalEndSubscription |
| 189 | + - goal_end |
| 190 | + * - Hype Train Begin |
| 191 | + - HypeTrainBeginSubscription |
| 192 | + - hype_train |
| 193 | + * - Hype Train Progress |
| 194 | + - HypeTrainProgressSubscription |
| 195 | + - hype_train_progress |
| 196 | + * - Hype Train End |
| 197 | + - HypeTrainEndSubscription |
| 198 | + - hype_train_end |
| 199 | + * - Shield Mode Begin |
| 200 | + - ShieldModeBeginSubscription |
| 201 | + - shield_mode_begin |
| 202 | + * - Shield Mode End |
| 203 | + - ShieldModeEndSubscription |
| 204 | + - shield_mode_end |
| 205 | + * - Shoutout Create |
| 206 | + - ShoutoutCreateSubscription |
| 207 | + - shoutout_create |
| 208 | + * - Shoutout Received |
| 209 | + - ShoutoutReceiveSubscription |
| 210 | + - shoutout_receive |
| 211 | + * - Stream Online |
| 212 | + - StreamOnlineSubscription |
| 213 | + - stream_online |
| 214 | + * - Stream Offline |
| 215 | + - StreamOfflineSubscription |
| 216 | + - stream_offline |
| 217 | + * - User Authorization Grant |
| 218 | + - UserAuthorizationGrantSubscription |
| 219 | + - user_authorization_grant |
| 220 | + * - User Authorization Revoke |
| 221 | + - UserAuthorizationRevokeSubscription |
| 222 | + - user_authorization_revoke |
| 223 | + * - User Update |
| 224 | + - UserUpdateSubscription |
| 225 | + - user_update |
| 226 | + * - Whisper Received |
| 227 | + - WhisperReceivedSubscription |
| 228 | + - message_whisper |
0 commit comments