Base EventSub Client#

Note

This is the base class used for all EventSub Transport implementations.

See EventSub for a list of all available Transports.

Class Documentation#

class twitchAPI.eventsub.base.EventSubBase#

Bases: ABC

EventSub integration for the Twitch Helix API.

__init__(twitch, logger_name)#
Parameters:

  • twitch (Twitch) – a app authenticated instance of Twitch

  • logger_name (str) – the name of the logger to be used

logger: Logger#

The logger used for EventSub related log messages

abstract start()#

Starts the EventSub client

Return type:

None

Raises:

RuntimeError – if EventSub is already running

abstract async stop()#

Stops the EventSub client

This also unsubscribes from all known subscriptions if unsubscribe_on_stop is True

Return type:

None

async unsubscribe_all()#

Unsubscribe from all subscriptions

async unsubscribe_all_known()#

Unsubscribe from all subscriptions known to this client.

async unsubscribe_topic(topic_id)#

Unsubscribe from a specific topic.

Return type:

bool

async listen_channel_update(broadcaster_user_id, callback)#

A broadcaster updates their channel properties e.g., category, title, mature flag, broadcast, or language.

No Authentication required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_update_v2(broadcaster_user_id, callback)#

A broadcaster updates their channel properties e.g., category, title, content classification labels or language.

No Authentication required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_follow_v2(broadcaster_user_id, moderator_user_id, callback)#

A specified channel receives a follow.

User Authentication with MODERATOR_READ_FOLLOWERS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelfollow

Parameters:

  • broadcaster_user_id (str) – the id of the user you want to listen to

  • moderator_user_id (str) – The ID of the moderator of the channel you want to get follow notifications for.

  • callback (Callable[[ChannelFollowEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_subscribe(broadcaster_user_id, callback)#

A notification when a specified channel receives a subscriber. This does not include resubscribes.

User Authentication with CHANNEL_READ_SUBSCRIPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelsubscribe

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_subscription_end(broadcaster_user_id, callback)#

A notification when a subscription to the specified channel ends.

User Authentication with CHANNEL_READ_SUBSCRIPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelsubscriptionend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_subscription_gift(broadcaster_user_id, callback)#

A notification when a viewer gives a gift subscription to one or more users in the specified channel.

User Authentication with CHANNEL_READ_SUBSCRIPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelsubscriptiongift

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_subscription_message(broadcaster_user_id, callback)#

A notification when a user sends a resubscription chat message in a specific channel.

User Authentication with CHANNEL_READ_SUBSCRIPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelsubscriptionmessage

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_cheer(broadcaster_user_id, callback)#

A user cheers on the specified channel.

User Authentication with BITS_READ is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelcheer

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_raid(callback, to_broadcaster_user_id=None, from_broadcaster_user_id=None)#

A broadcaster raids another broadcaster’s channel.

No authorization required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelraid

Parameters:

  • from_broadcaster_user_id (Optional[str]) – The broadcaster user ID that created the channel raid you want to get notifications for.

  • to_broadcaster_user_id (Optional[str]) – The broadcaster user ID that received the channel raid you want to get notifications for.

  • callback (Callable[[ChannelRaidEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_ban(broadcaster_user_id, callback)#

A viewer is banned from the specified channel.

User Authentication with CHANNEL_MODERATE is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelban

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_unban(broadcaster_user_id, callback)#

A viewer is unbanned from the specified channel.

User Authentication with CHANNEL_MODERATE is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelunban

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_moderator_add(broadcaster_user_id, callback)#

Moderator privileges were added to a user on a specified channel.

User Authentication with MODERATION_READ is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelmoderatoradd

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_moderator_remove(broadcaster_user_id, callback)#

Moderator privileges were removed from a user on a specified channel.

User Authentication with MODERATION_READ is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelmoderatorremove

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_custom_reward_add(broadcaster_user_id, callback)#

A custom channel points reward has been created for the specified channel.

User Authentication with CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardadd

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_custom_reward_update(broadcaster_user_id, callback, reward_id=None)#

A custom channel points reward has been updated for the specified channel.

User Authentication with CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_custom_reward_remove(broadcaster_user_id, callback, reward_id=None)#

A custom channel points reward has been removed from the specified channel.

User Authentication with CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_rewardremove

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_custom_reward_redemption_add(broadcaster_user_id, callback, reward_id=None)#

A viewer has redeemed a custom channel points reward on the specified channel.

User Authentication with CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_reward_redemptionadd

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_custom_reward_redemption_update(broadcaster_user_id, callback, reward_id=None)#

A redemption of a channel points custom reward has been updated for the specified channel.

User Authentication with CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelchannel_points_custom_reward_redemptionupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_poll_begin(broadcaster_user_id, callback)#

A poll started on a specified channel.

User Authentication with CHANNEL_READ_POLLS or CHANNEL_MANAGE_POLLS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpollbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_poll_progress(broadcaster_user_id, callback)#

Users respond to a poll on a specified channel.

User Authentication with CHANNEL_READ_POLLS or CHANNEL_MANAGE_POLLS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpollprogress

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_poll_end(broadcaster_user_id, callback)#

A poll ended on a specified channel.

User Authentication with CHANNEL_READ_POLLS or CHANNEL_MANAGE_POLLS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpollend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_prediction_begin(broadcaster_user_id, callback)#

A Prediction started on a specified channel.

User Authentication with CHANNEL_READ_PREDICTIONS or CHANNEL_MANAGE_PREDICTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpredictionbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_prediction_progress(broadcaster_user_id, callback)#

Users participated in a Prediction on a specified channel.

User Authentication with CHANNEL_READ_PREDICTIONS or CHANNEL_MANAGE_PREDICTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpredictionprogress

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_prediction_lock(broadcaster_user_id, callback)#

A Prediction was locked on a specified channel.

User Authentication with CHANNEL_READ_PREDICTIONS or CHANNEL_MANAGE_PREDICTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpredictionlock

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_prediction_end(broadcaster_user_id, callback)#

A Prediction ended on a specified channel.

User Authentication with CHANNEL_READ_PREDICTIONS or CHANNEL_MANAGE_PREDICTIONS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelpredictionend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_drop_entitlement_grant(organisation_id, callback, category_id=None, campaign_id=None)#

An entitlement for a Drop is granted to a user.

App access token required. The client ID associated with the access token must be owned by a user who is part of the specified organization.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#dropentitlementgrant

Parameters:

  • organisation_id (str) – The organization ID of the organization that owns the game on the developer portal.

  • category_id (Optional[str]) – The category (or game) ID of the game for which entitlement notifications will be received.

    Default: None

  • campaign_id (Optional[str]) – The campaign ID for a specific campaign for which entitlement notifications will be received.

    Default: None

  • callback (Callable[[DropEntitlementGrantEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_extension_bits_transaction_create(extension_client_id, callback)#

A Bits transaction occurred for a specified Twitch Extension.

The OAuth token client ID must match the Extension client ID.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#extensionbits_transactioncreate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_goal_begin(broadcaster_user_id, callback)#

A goal begins on the specified channel.

User Authentication with CHANNEL_READ_GOALS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelgoalbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_goal_progress(broadcaster_user_id, callback)#

A goal makes progress on the specified channel.

User Authentication with CHANNEL_READ_GOALS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelgoalprogress

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_goal_end(broadcaster_user_id, callback)#

A goal ends on the specified channel.

User Authentication with CHANNEL_READ_GOALS is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelgoalend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_hype_train_begin(broadcaster_user_id, callback)#

A Hype Train begins on the specified channel.

User Authentication with CHANNEL_READ_HYPE_TRAIN is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype_trainbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_hype_train_progress(broadcaster_user_id, callback)#

A Hype Train makes progress on the specified channel.

User Authentication with CHANNEL_READ_HYPE_TRAIN is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype_trainprogress

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_hype_train_end(broadcaster_user_id, callback)#

A Hype Train ends on the specified channel.

User Authentication with CHANNEL_READ_HYPE_TRAIN is required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelhype_trainend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_stream_online(broadcaster_user_id, callback)#

The specified broadcaster starts a stream.

No authorization required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#streamonline

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_stream_offline(broadcaster_user_id, callback)#

The specified broadcaster stops a stream.

No authorization required.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#streamoffline

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_user_authorization_grant(client_id, callback)#

A user’s authorization has been granted to your client id.

Provided client_id must match the client id in the application access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#userauthorizationgrant

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_user_authorization_revoke(client_id, callback)#

A user’s authorization has been revoked for your client id.

Provided client_id must match the client id in the application access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#userauthorizationrevoke

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_user_update(user_id, callback)#

A user has updated their account.

No authorization required. If you have the USER_READ_EMAIL scope, the notification will include email field.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#userupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shield_mode_begin(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when the broadcaster activates Shield Mode.

Requires the MODERATOR_READ_SHIELD_MODE or MODERATOR_MANAGE_SHIELD_MODE auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshield_modebegin

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster that you want to receive notifications about when they activate Shield Mode.

  • moderator_user_id (str) – The ID of the broadcaster or one of the broadcaster’s moderators.

  • callback (Callable[[ShieldModeEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shield_mode_end(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when the broadcaster deactivates Shield Mode.

Requires the MODERATOR_READ_SHIELD_MODE or MODERATOR_MANAGE_SHIELD_MODE auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshield_modeend

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster that you want to receive notifications about when they deactivate Shield Mode.

  • moderator_user_id (str) – The ID of the broadcaster or one of the broadcaster’s moderators.

  • callback (Callable[[ShieldModeEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_charity_campaign_start(broadcaster_user_id, callback)#

Sends a notification when the broadcaster starts a charity campaign.

Requires the CHANNEL_READ_CHARITY auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignstart

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_charity_campaign_progress(broadcaster_user_id, callback)#

Sends notifications when progress is made towards the campaign’s goal or when the broadcaster changes the fundraising goal.

Requires the CHANNEL_READ_CHARITY auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignprogress

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_charity_campaign_stop(broadcaster_user_id, callback)#

Sends a notification when the broadcaster stops a charity campaign.

Requires the CHANNEL_READ_CHARITY auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaignstop

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_charity_campaign_donate(broadcaster_user_id, callback)#

Sends a notification when a user donates to the broadcaster’s charity campaign.

Requires the CHANNEL_READ_CHARITY auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelcharity_campaigndonate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shoutout_create(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when the specified broadcaster sends a Shoutout.

Requires the MODERATOR_READ_SHOUTOUTS or MODERATOR_MANAGE_SHOUTOUTS auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshoutoutcreate

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster that you want to receive notifications about when they send a Shoutout.

  • moderator_user_id (str) – The ID of the broadcaster that gave the Shoutout or one of the broadcaster’s moderators.

  • callback (Callable[[ChannelShoutoutCreateEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shoutout_receive(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when the specified broadcaster receives a Shoutout.

Requires the MODERATOR_READ_SHOUTOUTS or MODERATOR_MANAGE_SHOUTOUTS auth scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshoutoutreceive

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster that you want to receive notifications about when they receive a Shoutout.

  • moderator_user_id (str) – The ID of the broadcaster that received the Shoutout or one of the broadcaster’s moderators.

  • callback (Callable[[ChannelShoutoutReceiveEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_clear(broadcaster_user_id, user_id, callback)#

A moderator or bot has cleared all messages from the chat room.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatclear

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_clear_user_messages(broadcaster_user_id, user_id, callback)#

A moderator or bot has cleared all messages from a specific user.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatclear_user_messages

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_message_delete(broadcaster_user_id, user_id, callback)#

A moderator has removed a specific message.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatmessage_delete

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_notification(broadcaster_user_id, user_id, callback)#

A notification for when an event that appears in chat has occurred.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatnotification

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_ad_break_begin(broadcaster_user_id, callback)#

A midroll commercial break has started running.

Requires the CHANNEL_READ_ADS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelad_breakbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_message(broadcaster_user_id, user_id, callback)#

Any user sends a message to a specific chat room.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatmessage

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_settings_update(broadcaster_user_id, user_id, callback)#

This event sends a notification when a broadcaster’s chat settings are updated.

Requires USER_READ_CHAT scope from chatting user. If app access token used, then additionally requires USER_BOT scope from chatting user, and either CHANNEL_BOT scope from broadcaster or moderator status.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchat_settingsupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_user_whisper_message(user_id, callback)#

Sends a notification when a user receives a whisper. Event Triggers - Anyone whispers the specified user.

Requires USER_READ_WHISPERS or USER_MANAGE_WHISPERS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#userwhispermessage

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_points_automatic_reward_redemption_add(broadcaster_user_id, callback)#

A viewer has redeemed an automatic channel points reward on the specified channel.

Requires CHANNEL_READ_REDEMPTIONS or CHANNEL_MANAGE_REDEMPTIONS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchannel_points_automatic_reward_redemptionadd

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_vip_add(broadcaster_user_id, callback)#

A VIP is added to the channel.

Requires CHANNEL_READ_VIPS or CHANNEL_MANAGE_VIPS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelvipadd

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_vip_remove(broadcaster_user_id, callback)#

A VIP is removed from the channel.

Requires CHANNEL_READ_VIPS or CHANNEL_MANAGE_VIPS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelvipremove

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_unban_request_create(broadcaster_user_id, moderator_user_id, callback)#

A user creates an unban request.

Requires MODERATOR_READ_UNBAN_REQUESTS or MODERATOR_MANAGE_UNBAN_REQUESTS scope.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelunban_requestcreate

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster you want to get chat unban request notifications for.

  • moderator_user_id (str) – The ID of the user that has permission to moderate the broadcaster’s channel and has granted your app permission to subscribe to this subscription type.

  • callback (Callable[[ChannelUnbanRequestCreateEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_unban_request_resolve(broadcaster_user_id, moderator_user_id, callback)#

An unban request has been resolved.

Requires MODERATOR_READ_UNBAN_REQUESTS or MODERATOR_MANAGE_UNBAN_REQUESTS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelunban_requestresolve

Parameters:

  • broadcaster_user_id (str) – The ID of the broadcaster you want to get unban request resolution notifications for.

  • moderator_user_id (str) – The ID of the user that has permission to moderate the broadcaster’s channel and has granted your app permission to subscribe to this subscription type.

  • callback (Callable[[ChannelUnbanRequestResolveEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_suspicious_user_message(broadcaster_user_id, moderator_user_id, callback)#

A chat message has been sent by a suspicious user.

Requires MODERATOR_READ_SUSPICIOUS_USERS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsuspicious_usermessage

Parameters:

  • broadcaster_user_id (str) – User ID of the channel to receive chat message events for.

  • moderator_user_id (str) – The ID of a user that has permission to moderate the broadcaster’s channel and has granted your app permission to subscribe to this subscription type.

  • callback (Callable[[ChannelSuspiciousUserMessageEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_suspicious_user_update(broadcaster_user_id, moderator_user_id, callback)#

A suspicious user has been updated.

Requires MODERATOR_READ_SUSPICIOUS_USERS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelsuspicious_userupdate

Parameters:

  • broadcaster_user_id (str) – The broadcaster you want to get chat unban request notifications for.

  • moderator_user_id (str) – The ID of a user that has permission to moderate the broadcaster’s channel and has granted your app permission to subscribe to this subscription type.

  • callback (Callable[[ChannelSuspiciousUserUpdateEvent], Awaitable[None]]) – function for callback

Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_moderate(broadcaster_user_id, moderator_user_id, callback)#

A moderator performs a moderation action in a channel. Includes warnings.

Requires all of the following scopes:

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelmoderate-v2

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_warning_acknowledge(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when a warning is acknowledged by a user.

Requires MODERATOR_READ_WARNINGS or MODERATOR_MANAGE_WARNINGS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelwarningacknowledge

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_warning_send(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when a warning is send to a user. Broadcasters and moderators can see the warning’s details.

Requires MODERATOR_READ_WARNINGS or MODERATOR_MANAGE_WARNINGS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelwarningsend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_automod_message_hold(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification if a message was caught by automod for review.

Requires MODERATOR_MANAGE_AUTOMOD scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#automodmessagehold

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_automod_message_update(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when a message in the automod queue has its status changed.

Requires MODERATOR_MANAGE_AUTOMOD scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#automodmessageupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_automod_settings_update(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when the broadcaster’s automod settings are updated.

Requires MODERATOR_READ_AUTOMOD_SETTINGS scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#automodsettingsupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_automod_terms_update(broadcaster_user_id, moderator_user_id, callback)#

Sends a notification when a broadcaster’s automod terms are updated.

Requires MODERATOR_MANAGE_AUTOMOD scope.

Note

If you use webhooks, the user in moderator_user_id must have granted your app (client ID) one of the above permissions prior to your app subscribing to this subscription type.

If you use WebSockets, the ID in moderator_user_id must match the user ID in the user access token.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#automodtermsupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_user_message_hold(broadcaster_user_id, user_id, callback)#

A user is notified if their message is caught by automod.

Note

Requires USER_READ_CHAT scope from the chatting user.

If WebSockets is used, additionally requires USER_BOT from chatting user.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatuser_message_hold

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_chat_user_message_update(broadcaster_user_id, user_id, callback)#

A user is notified if their message’s automod status is updated.

Note

Requires USER_READ_CHAT scope from the chatting user.

If WebSockets is used, additionally requires USER_BOT from chatting user.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelchatuser_message_update

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shared_chat_begin(broadcaster_user_id, callback)#

A notification when a channel becomes active in an active shared chat session.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatbegin

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shared_chat_update(broadcaster_user_id, callback)#

A notification when the active shared chat session the channel is in changes.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatupdate

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

async listen_channel_shared_chat_end(broadcaster_user_id, callback)#

A notification when a channel leaves a shared chat session or the session ends.

For more information see here: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types/#channelshared_chatend

Parameters:
Raises:
Return type:

str

Returns:

The id of the topic subscription

On this page