207 lines
13 KiB
Go
207 lines
13 KiB
Go
|
package api
|
|||
|
|
|
|||
|
|
type SubscriptionType string
|
|||
|
|
|
|||
|
|
// Automod
|
|||
|
|
|
|||
|
|
// Version 1 - A user is notified if a message is caught by automod for review.
|
|||
|
|
const AUTOMOD_MESSAGE_HOLD SubscriptionType = "automod.message.hold"
|
|||
|
|
// Version 2 - A user is notified if a message is caught by automod for review. Only public blocked terms trigger notifications, not private ones.
|
|||
|
|
const AUTOMOD_MESSAGE_HOLD_V2 SubscriptionType = "automod.message.hold"
|
|||
|
|
// Version 1 - A message in the automod queue had its status changed.
|
|||
|
|
const AUTOMOD_MESSAGE_UPDATE SubscriptionType = "automod.message.update"
|
|||
|
|
// Version 2 - A message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones.
|
|||
|
|
const AUTOMOD_MESSAGE_UPDATE_V2 SubscriptionType = "automod.message.update"
|
|||
|
|
// Version 1 - A notification is sent when a broadcaster’s automod settings are updated.
|
|||
|
|
const AUTOMOD_SETTINGS_UPDATE SubscriptionType = "automod.settings.update"
|
|||
|
|
// Version 1 - A notification is sent when a broadcaster’s automod terms are updated. Changes to private terms are not sent.
|
|||
|
|
const AUTOMOD_TERMS_UPDATE SubscriptionType = "automod.terms.update"
|
|||
|
|
|
|||
|
|
// Channel
|
|||
|
|
|
|||
|
|
// Version 1 - A notification is sent whenever Bits are used on a channel.
|
|||
|
|
const CHANNEL_BITS_USE SubscriptionType = "channel.bits.use"
|
|||
|
|
// Version 2 - A broadcaster updates their channel properties e.g., category, title, content classification labels, broadcast, or language.
|
|||
|
|
const CHANNEL_UPDATE SubscriptionType = "channel.update"
|
|||
|
|
// Version 2 - A specified channel receives a follow.
|
|||
|
|
const CHANNEL_FOLLOW SubscriptionType = "channel.follow"
|
|||
|
|
// Version 1 - A midroll commercial break has started running.
|
|||
|
|
const CHANNEL_AD_BREAK_BEGIN SubscriptionType = "channel.ad_break.begin"
|
|||
|
|
|
|||
|
|
// Chat
|
|||
|
|
|
|||
|
|
// Version 1 - A moderator or bot has cleared all messages from the chat room.
|
|||
|
|
const CHANNEL_CHAT_CLEAR SubscriptionType = "channel.chat.clear"
|
|||
|
|
// Version 1 - A moderator or bot has cleared all messages from a specific user.
|
|||
|
|
const CHANNEL_CHAT_CLEAR_USER_MESSAGES SubscriptionType = "channel.chat.clear_user_messages"
|
|||
|
|
// Version 1 - Any user sends a message to a specific chat room.
|
|||
|
|
const CHANNEL_CHAT_MESSAGE SubscriptionType = "channel.chat.message"
|
|||
|
|
// Version 1 - A moderator has removed a specific message.
|
|||
|
|
const CHANNEL_CHAT_MESSAGE_DELETE SubscriptionType = "channel.chat.message_delete"
|
|||
|
|
// Version 1 - A notification for when an event that appears in chat has occurred.
|
|||
|
|
const CHANNEL_CHAT_NOTIFICATION SubscriptionType = "channel.chat.notification"
|
|||
|
|
// Version 1 - A notification for when a broadcaster’s chat settings are updated.
|
|||
|
|
const CHANNEL_CHAT_SETTINGS_UPDATE SubscriptionType = "channel.chat_settings.update"
|
|||
|
|
// Version 1 - A user is notified if their message is caught by automod.
|
|||
|
|
const CHANNEL_CHAT_USER_MESSAGE_HOLD SubscriptionType = "channel.chat.user_message_hold"
|
|||
|
|
// Version 1 - A user is notified if their message’s automod status is updated.
|
|||
|
|
const CHANNEL_CHAT_USER_MESSAGE_UPDATE SubscriptionType = "channel.chat.user_message_update"
|
|||
|
|
|
|||
|
|
// Shared Chat
|
|||
|
|
|
|||
|
|
// Version 1 - A notification when a channel becomes active in an active shared chat session.
|
|||
|
|
const CHANNEL_SHARED_CHAT_SESSION_BEGIN SubscriptionType = "channel.shared_chat.begin"
|
|||
|
|
// Version 1 - A notification when the active shared chat session the channel is in changes.
|
|||
|
|
const CHANNEL_SHARED_CHAT_SESSION_UPDATE SubscriptionType = "channel.shared_chat.update"
|
|||
|
|
// Version 1 - A notification when a channel leaves a shared chat session or the session ends.
|
|||
|
|
const CHANNEL_SHARED_CHAT_SESSION_END SubscriptionType = "channel.shared_chat.end"
|
|||
|
|
|
|||
|
|
// Subscriptions
|
|||
|
|
|
|||
|
|
// Version 1 - A notification is sent when a specified channel receives a subscriber. This does not include resubscribes.
|
|||
|
|
const CHANNEL_SUBSCRIBE SubscriptionType = "channel.subscribe"
|
|||
|
|
// Version 1 - A notification when a subscription to the specified channel ends.
|
|||
|
|
const CHANNEL_SUBSCRIPTION_END SubscriptionType = "channel.subscription.end"
|
|||
|
|
// Version 1 - A notification when a viewer gives a gift subscription to one or more users in the specified channel.
|
|||
|
|
const CHANNEL_SUBSCRIPTION_GIFT SubscriptionType = "channel.subscription.gift"
|
|||
|
|
// Version 1 - A notification when a user sends a resubscription chat message in a specific channel.
|
|||
|
|
const CHANNEL_SUBSCRIPTION_MESSAGE SubscriptionType = "channel.subscription.message"
|
|||
|
|
|
|||
|
|
// Version 1 - A user cheers on the specified channel.
|
|||
|
|
const CHANNEL_CHEER SubscriptionType = "channel.cheer"
|
|||
|
|
// Version 1 - A broadcaster raids another broadcaster’s channel.
|
|||
|
|
const CHANNEL_RAID SubscriptionType = "channel.raid"
|
|||
|
|
|
|||
|
|
// Version 1 - A viewer is banned from the specified channel.
|
|||
|
|
const CHANNEL_BAN SubscriptionType = "channel.ban"
|
|||
|
|
// Version 1 - A viewer is unbanned from the specified channel.
|
|||
|
|
const CHANNEL_UNBAN SubscriptionType = "channel.unban"
|
|||
|
|
// Version 1 - A user creates an unban request.
|
|||
|
|
const CHANNEL_UNBAN_REQUEST_CREATE SubscriptionType = "channel.unban_request.create"
|
|||
|
|
// Version 1 - An unban request has been resolved.
|
|||
|
|
const CHANNEL_UNBAN_REQUEST_RESOLVE SubscriptionType = "channel.unban_request.resolve"
|
|||
|
|
|
|||
|
|
// Version 1 - A moderator performs a moderation action in a channel.
|
|||
|
|
const CHANNEL_MODERATE SubscriptionType = "channel.moderate"
|
|||
|
|
// Version 2 - A moderator performs a moderation action in a channel. Includes warnings.
|
|||
|
|
const CHANNEL_MODERATE_V2 SubscriptionType = "channel.moderate"
|
|||
|
|
// Version 1 - Moderator privileges were added to a user on a specified channel.
|
|||
|
|
const CHANNEL_MODERATOR_ADD SubscriptionType = "channel.moderator.add"
|
|||
|
|
// Version 1 - Moderator privileges were removed from a user on a specified channel.
|
|||
|
|
const CHANNEL_MODERATOR_REMOVE SubscriptionType = "channel.moderator.remove"
|
|||
|
|
|
|||
|
|
// Version beta - The host began a new Guest Star session.
|
|||
|
|
const CHANNEL_GUEST_STAR_SESSION_BEGIN SubscriptionType = "channel.guest_star_session.begin"
|
|||
|
|
// Version beta - A running Guest Star session has ended.
|
|||
|
|
const CHANNEL_GUEST_STAR_SESSION_END SubscriptionType = "channel.guest_star_session.end"
|
|||
|
|
// Version beta - A guest or a slot is updated in an active Guest Star session.
|
|||
|
|
const CHANNEL_GUEST_STAR_GUEST_UPDATE SubscriptionType = "channel.guest_star_guest.update"
|
|||
|
|
// Version beta - The host preferences for Guest Star have been updated.
|
|||
|
|
const CHANNEL_GUEST_STAR_SETTINGS_UPDATE SubscriptionType = "channel.guest_star_settings.update"
|
|||
|
|
|
|||
|
|
// Version 1 - A viewer has redeemed an automatic channel points reward on the specified channel.
|
|||
|
|
const CHANNEL_POINTS_AUTOMATIC_REWARD_REDEMPTION_ADD SubscriptionType = "channel.channel_points_automatic_reward_redemption.add"
|
|||
|
|
// Version 2 - A viewer has redeemed an automatic channel points reward on the specified channel.
|
|||
|
|
const CHANNEL_POINTS_AUTOMATIC_REWARD_REDEMPTION_ADD_V2 SubscriptionType = "channel.channel_points_automatic_reward_redemption.add"
|
|||
|
|
// Version 1 - A custom channel points reward has been created for the specified channel.
|
|||
|
|
const CHANNEL_POINTS_CUSTOM_REWARD_ADD SubscriptionType = "channel.channel_points_custom_reward.add"
|
|||
|
|
// Version 1 - A custom channel points reward has been updated for the specified channel.
|
|||
|
|
const CHANNEL_POINTS_CUSTOM_REWARD_UPDATE SubscriptionType = "channel.channel_points_custom_reward.update"
|
|||
|
|
// Version 1 - A custom channel points reward has been removed from the specified channel.
|
|||
|
|
const CHANNEL_POINTS_CUSTOM_REWARD_REMOVE SubscriptionType = "channel.channel_points_custom_reward.remove"
|
|||
|
|
// Version 1 - A viewer has redeemed a custom channel points reward on the specified channel.
|
|||
|
|
const CHANNEL_POINTS_CUSTOM_REWARD_REDEMPTION_ADD SubscriptionType = "channel.channel_points_custom_reward_redemption.add"
|
|||
|
|
// Version 1 - A redemption of a channel points custom reward has been updated for the specified channel.
|
|||
|
|
const CHANNEL_POINTS_CUSTOM_REWARD_REDEMPTION_UPDATE SubscriptionType = "channel.channel_points_custom_reward_redemption.update"
|
|||
|
|
// Version 1 - A viewer has redeemed a custom Power-up on the specified channel.
|
|||
|
|
const CHANNEL_CUSTOM_POWER_UPS_REDEMPTION_ADD SubscriptionType = "channel.custom_power_up_redemption.add"
|
|||
|
|
|
|||
|
|
// Version 1 - A poll started on a specified channel.
|
|||
|
|
const CHANNEL_POLL_BEGIN SubscriptionType = "channel.poll.begin"
|
|||
|
|
// Version 1 - Users respond to a poll on a specified channel.
|
|||
|
|
const CHANNEL_POLL_PROGRESS SubscriptionType = "channel.poll.progress"
|
|||
|
|
// Version 1 - A poll ended on a specified channel.
|
|||
|
|
const CHANNEL_POLL_END SubscriptionType = "channel.poll.end"
|
|||
|
|
|
|||
|
|
// Version 1 - A Prediction started on a specified channel.
|
|||
|
|
const CHANNEL_PREDICTION_BEGIN SubscriptionType = "channel.prediction.begin"
|
|||
|
|
// Version 1 - Users participated in a Prediction on a specified channel.
|
|||
|
|
const CHANNEL_PREDICTION_PROGRESS SubscriptionType = "channel.prediction.progress"
|
|||
|
|
// Version 1 - A Prediction was locked on a specified channel.
|
|||
|
|
const CHANNEL_PREDICTION_LOCK SubscriptionType = "channel.prediction.lock"
|
|||
|
|
// Version 1 - A Prediction ended on a specified channel.
|
|||
|
|
const CHANNEL_PREDICTION_END SubscriptionType = "channel.prediction.end"
|
|||
|
|
|
|||
|
|
// Version 1 - A chat message has been sent by a suspicious user.
|
|||
|
|
const CHANNEL_SUSPICIOUS_USER_MESSAGE SubscriptionType = "channel.suspicious_user.message"
|
|||
|
|
// Version 1 - A suspicious user has been updated.
|
|||
|
|
const CHANNEL_SUSPICIOUS_USER_UPDATE SubscriptionType = "channel.suspicious_user.update"
|
|||
|
|
|
|||
|
|
// Version 1 - A VIP is added to the channel.
|
|||
|
|
const CHANNEL_VIP_ADD SubscriptionType = "channel.vip.add"
|
|||
|
|
// Version 1 - A VIP is removed from the channel.
|
|||
|
|
const CHANNEL_VIP_REMOVE SubscriptionType = "channel.vip.remove"
|
|||
|
|
|
|||
|
|
// Version 1 - A user acknowledges a warning. Broadcasters and moderators can see the warning’s details.
|
|||
|
|
const CHANNEL_WARNING_ACKNOWLEDGEMENT SubscriptionType = "channel.warning.acknowledge"
|
|||
|
|
// Version 1 - A user is sent a warning. Broadcasters and moderators can see the warning’s details.
|
|||
|
|
const CHANNEL_WARNING_SEND SubscriptionType = "channel.warning.send"
|
|||
|
|
|
|||
|
|
// Version 1 - Sends an event notification when a user donates to the broadcaster’s charity campaign.
|
|||
|
|
const CHARITY_DONATION SubscriptionType = "channel.charity_campaign.donate"
|
|||
|
|
// Version 1 - Sends an event notification when the broadcaster starts a charity campaign.
|
|||
|
|
const CHARITY_CAMPAIGN_START SubscriptionType = "channel.charity_campaign.start"
|
|||
|
|
// Version 1 - Sends an event notification when progress is made towards the campaign’s goal or when the broadcaster changes the fundraising goal.
|
|||
|
|
const CHARITY_CAMPAIGN_PROGRESS SubscriptionType = "channel.charity_campaign.progress"
|
|||
|
|
// Version 1 - Sends an event notification when the broadcaster stops a charity campaign.
|
|||
|
|
const CHARITY_CAMPAIGN_STOP SubscriptionType = "channel.charity_campaign.stop"
|
|||
|
|
|
|||
|
|
// Version 1 - Sends a notification when EventSub disables a shard due to the status of the underlying transport changing.
|
|||
|
|
const CONDUIT_SHARD_DISABLED SubscriptionType = "conduit.shard.disabled"
|
|||
|
|
|
|||
|
|
// Version 1 - An entitlement for a Drop is granted to a user.
|
|||
|
|
const DROP_ENTITLEMENT_GRANT SubscriptionType = "drop.entitlement.grant"
|
|||
|
|
|
|||
|
|
// Version 1 - A Bits transaction occurred for a specified Twitch Extension.
|
|||
|
|
const EXTENSION_BITS_TRANSACTION_CREATE SubscriptionType = "extension.bits_transaction.create"
|
|||
|
|
|
|||
|
|
// Version 1 - Get notified when a broadcaster begins a goal.
|
|||
|
|
const GOAL_BEGIN SubscriptionType = "channel.goal.begin"
|
|||
|
|
// Version 1 - Get notified when progress (either positive or negative) is made towards a broadcaster’s goal.
|
|||
|
|
const GOAL_PROGRESS SubscriptionType = "channel.goal.progress"
|
|||
|
|
// Version 1 - Get notified when a broadcaster ends a goal.
|
|||
|
|
const GOAL_END SubscriptionType = "channel.goal.end"
|
|||
|
|
|
|||
|
|
// Version 2 - A Hype Train begins on the specified channel.
|
|||
|
|
const HYPE_TRAIN_BEGIN SubscriptionType = "channel.hype_train.begin"
|
|||
|
|
// Version 2 - A Hype Train makes progress on the specified channel.
|
|||
|
|
const HYPE_TRAIN_PROGRESS SubscriptionType = "channel.hype_train.progress"
|
|||
|
|
// Version 2 - A Hype Train ends on the specified channel.
|
|||
|
|
const HYPE_TRAIN_END SubscriptionType = "channel.hype_train.end"
|
|||
|
|
|
|||
|
|
// Version 1 - Sends a notification when the broadcaster activates Shield Mode.
|
|||
|
|
const SHIELD_MODE_BEGIN SubscriptionType = "channel.shield_mode.begin"
|
|||
|
|
// Version 1 - Sends a notification when the broadcaster deactivates Shield Mode.
|
|||
|
|
const SHIELD_MODE_END SubscriptionType = "channel.shield_mode.end"
|
|||
|
|
|
|||
|
|
// Version 1 - Sends a notification when the specified broadcaster sends a Shoutout.
|
|||
|
|
const SHOUTOUT_CREATE SubscriptionType = "channel.shoutout.create"
|
|||
|
|
// Version 1 - Sends a notification when the specified broadcaster receives a Shoutout.
|
|||
|
|
const SHOUTOUT_RECEIVED SubscriptionType = "channel.shoutout.receive"
|
|||
|
|
|
|||
|
|
// Version 1 - The specified broadcaster starts a stream.
|
|||
|
|
const STREAM_ONLINE SubscriptionType = "stream.online"
|
|||
|
|
// Version 1 - The specified broadcaster stops a stream.
|
|||
|
|
const STREAM_OFFLINE SubscriptionType = "stream.offline"
|
|||
|
|
|
|||
|
|
// Version 1 - A user’s authorization has been granted to your client id.
|
|||
|
|
const USER_AUTHORIZATION_GRANT SubscriptionType = "user.authorization.grant"
|
|||
|
|
// Version 1 - A user’s authorization has been revoked for your client id.
|
|||
|
|
const USER_AUTHORIZATION_REVOKE SubscriptionType = "user.authorization.revoke"
|
|||
|
|
|
|||
|
|
// Version 1 - A user has updated their account.
|
|||
|
|
const USER_UPDATE SubscriptionType = "user.update"
|
|||
|
|
|
|||
|
|
// Version 1 - A user receives a whisper.
|
|||
|
|
const WHISPER_RECEIVED SubscriptionType = "user.whisper.message"
|