V1 of the channel.bits.use EventSub subscription type have received the following updates.

• Custom Power-ups have been added as an event type
• Combos has been removed from event types

V1 of the channel.chat.notification EventSub subscription type has been updated to include is_source_only for chat announcements during a shared chat session.

The Send Chat Announcement API endpoint has received the following updates.

• Added support for app access token authorization
• Added the for_source_only optional parameter to specify during a shared chat session if the announcement should be sent only to the source channel or both channels

• Create Clip From VOD
• Add Suspicious Status to Chat User
• Remove Suspicious Status From Chat User

The “Get Hype Train Events” API endpoint has been removed in favor of Get Hype Train Status. See more information in the related announcement.

• Add suspicious status to chat user - Adds a suspicious user status to a chatter on the broadcaster’s channel.
• Remove suspicious status from chat user - Remove a suspicious user status from a chatter on broadcaster’s channel.

• 日本語
• 中文 简体
• 한국어
• العربية

For more details, see our announcement.

• Get Authorization By User - Gets the authorization scopes that the specified user(s) have granted the application.

• Get Clips Download - Provides URLs to download the video file(s) for the specified clips.

• Get Hype Train Status - Get the status of a Hype Train for the specified broadcaster.

• Channel Hype Train Begin - A Hype Train begins on the specified channel.
  • channel.hype_train.begin V1
  • channel.hype_train.begin V2
• Channel Hype Train Progress - A Hype Train makes progress on the specified channel.
  • channel.hype_train.progress V1
  • channel.hype_train.progress V2
• Channel Hype Train End - A Hype Train ends on the specified channel.
  • channel.hype_train.end V1
  • channel.hype_train.end V2

• Get EventSub Subscriptions has been updated to include the new subscription_id parameter that returns an array with the subscription matching the ID (as long as it is owned by the client making the request), or an empty array if there is no matching subscription.
• Channel Bits Use has been updated to send when a user Combos in a channel.

The new is_source_only field and for_source_only parameter have been added to Channel Chat Message and Send Chat Message to indicate, when in a shared chat session, if a chat message is sent only to the source channel or both channels.

Updates and additions are now reflected in the following:

1. Updated EventSub subscription:
   • Channel Chat Message
     • channel.chat.messsage - Any user sends a message to a specific chat room.
2. Updated API:
   • Send Chat Message
     • Send Chat Message - Sends a message to the broadcaster’s chat room.
3. Added IRC PRIVMSG tag:
   • source-only
     • source-only - A Boolean that indicates if a message sent during a shared chat session is only sent to the source channel. Has no effect if the message is not sent during a shared chat session.

1. EventSub:
   • Channel Suspicious User Message Event - Updated the types field to reflect the following return values:
     • ban_evader
     • manually_added
     • banned_in_shared_channel
   • Get EventSub Subscriptions - Updated the following note to accurately reflect the functionality when a WebSocket is disconnected:
     • The GET API returns disabled WebSocket subscriptions for a minimum of 1 minute as compared to webhooks which returns disabled subscriptions for a minimum of 10 days.
2. Twitch API:
   • Update User API Endpoint- Added a new error code:
     • 429 Too many requests: The app exceeded the number of requests that it may make.

1. Channel Bits Use - Updated from open beta to V1.
2. Channel Points Automatic Reward Redemption Add V2 - Updated from open beta to V2.

1. Channel Bits Use - Added the following parameters:
   • emote_set_id
   • owner_id
   • format
2. Get Extension Live Channels - updated the following parameter to better reflect its actual functionality.
   • first - The specific maximum number of items per page in the response. The actual number returned may be less than this limit. Read More

• channel.channel_points_automatic_reward_redemption.add - A viewer has redeemed an automatic channel points reward on the specified channel.

• Channel Bits Use - A notification is sent whenever Bits are used on a channel.

The following V2 Automod Message EventSub subscription types are now available in v2:

• automod.message.hold - A user is notified if a message is caught by automod for review. Only public blocked terms trigger notifications, not private ones.
• automod.mesage.update - A message in the automod queue had its status changed. Only public blocked terms trigger notifications, not private ones.

We have also revised the Developer Services Agreement to include subscription-based Twitch Drops, and reorganized related Drops information. Game developers who currently or plan to use Twitch Drops should take a moment to review the revised Agreement.

1. Added information about the Game Maker version of the Twitch Game Engine Plugins

Hype Train EventSub subscription types now indicate whether a Hype Train is a Golden Kappa Train:

• channel.hype_train.begin - A Hype Train begins on the specified channel.
• channel.hype_train.progress - A Hype Train makes progress on the specified channel.
• channel.hype_train.end - A Hype Train ends on the specified channel.

The following V2 Automod Message EventSub subscription types are now available in open beta:

• automod.message.hold - A user is notified if a message is caught by automod for review.
• automod.mesage.update - A message in the automod queue had its status changed.

1. The following EventSub subscription types were updated from open beta to V1:
   • Shared Chat
     • channel.shared_chat.begin - A notification when a channel becomes active in an active shared chat session.
     • channel.shared_chat.update - A notification when the active shared chat session the channel is in changes.
     • channel.shared_chat.end - A notification when a channel leaves a shared chat session or the session ends.
2. The following API was updated from open beta to V1:
   • Get Shared Chat Session
     • Get Shared Chat Session - Retrieves the active shared chat session for a channel.

1. Updated IRC PRIVMSG tags to include the following new tags:
   • source-room-id
   • source-id
   • source-badges
   • source-badge-info
2. Updated IRC USERNOTICE tags to include the following changes:
   • Introduced new tag source-room-id
   • Introduced new tag source-id
   • Introduced new tag source-msg-id
   • Introduced new tag source-badges
   • Introduced new tag source-badge-info
   • Added possible value of sharedchatnotice to the existing msg-id tag
3. Added Shared Chat section to IRC Concepts, detailing the handling of Shared Chat on IRC

1. The following EventSub subscription types are now available in open beta:
   • Shared Chat
     • channel.shared_chat.begin - A notification when a channel becomes active in an active shared chat session.
     • channel.shared_chat.update - A notification when the active shared chat session the channel is in changes.
     • channel.shared_chat.end - A notification when a channel leaves a shared chat session or the session ends.
2. The following item was added to the API reference in open beta:
   • Get Shared Chat Session
     • Get Shared Chat Session - Retrieves the active shared chat session for a channel.
3. The following EventSub subscription types have been updated:
   • Chat Message
     • channel.chat.message V1
   • Chat Notification
     • channel.chat.notification
   • Chat Moderate V1 and V2
     • channel.moderate V1
     • channel.moderate V2

1. The Chat & Chatbots section has been reworked to describe information about Chat using EventSub and IRC.
   • IRC reference pages were merged into the IRC Concepts page.
   • The page Moderating a Broadcaster’s chat under Twitch API was moved to Chat & Chatbots as Moderation. The old page URL will redirect to the new location.
2. The Scopes page was updated to contain clearer and additional information:
   • Scopes are split by API/EventSub, IRC, and PubSub.
   • Links to EventSub reference were added to relevant scopes

1. The following EventSub subscription types were updated from open beta to V1:
   • Channel Warnings
     • channel.warning.acknowledge - A user acknowledges a warning.
     • channel.warning.send - A user is sent a warning.
2. The following EventSub subscription type was updated from open beta to V2:
   • Moderator Actions
     • channel.moderate v2 - A moderator performs a moderation action in a channel. Includes warnings.
3. The following API endpoint was updated from open beta to V1:
   • Warn Chat User
     • Warn Chat User API Endpoint - Warns a user in the specified broadcaster’s chat room, preventing them from interaction with the chat until the warning is acknowledged.
4. The following scopes were added to the Twitch API scopes:
   • moderator:manage:warnings - Warn users in channels where you have the moderator role.
   • moderator:read:warnings - Read warnings in channels where you have the moderator role.

1. There is no longer a requirement to have an Apple Developer account, or fill out the iOS Allowlist form, to allow an Extension to work on the iOS version of the Twitch app. All mobile Extensions, existing and new, are available on iOS and Android without additional requirements in the submission process.
   • Developer Forums announcement
   • Updated messaging in Building Extensions.
2. Added policy 3.5 to Extensions Guidelines & Policies.

1. The following EventSub subscription types are now available in open beta:
   • Moderator Actions
     • channel.moderate v2 - A moderator performs a moderation action in a channel. Includes warnings. This event’s version will eventually migrate version from beta to 2 in a future release.
   • Channel Warnings
     • channel.warning.acknowledge - A user acknowledges a warning.
     • channel.warning.send - A user is sent a warning.
2. The following item was added to the API reference in open beta:
   • Warn Chat User
     • Warn Chat User API Endpoint - Warns a user in the specified broadcaster’s chat room, preventing them from interaction with the chat until the warning is acknowledged.

1. Channel Chat Message:
   • The following enum values for the message_type field have been changed:
     • animated has been renamed to power_ups_message_effect
     • gigantified_emote has been renamed to power_ups_gigantified_emote
2. Automatic Point Redemption Add:
   • The following enum values for the reward_type field have been changed:
     • send_animated_message has been renamed to message_effect
     • send_gigantified_emote has been renamed to gigantify_an_emote

1. General improvements made to Unity Guide
   • Fixed Typos
   • General code improvements
   • General rewording to improve readability
   • Updated unitypackage to include experiemental Mac support

1. Channel Chat Message now supports:
   • A new field:
     • channel_points_animation_id
   • The following new enum values for the message_type field:
     • animated
     • gigantified_emote
2. Automatic Point Redemption Add now supports:
   • The following new enum values for the reward_type field:
     • send_animated_message
     • send_gigantified_emote
     • celebration

1. All Goal Subscription EventSub events were updated to include two new goal type values:
   • new_bit
   • new_cheerer

1. The following items were updated from open beta to V1:
   • Low Trust User (Suspicious User)
     • channel.suspicious_user.message - A chat message has been sent by a suspicious user.
     • channel.suspicious_user.update - A suspicious user has been updated.
2. Made updates to Get User Emotes API endpoint:
   • Re-added broadcaster_id query parameter. The description of this query parameter was updated to reflect it’s purpose.

1. The following events are now available in open beta:
   • Low Trust User (Suspicious User)
     • channel.suspicious_user.message - A chat message has been sent by a suspicious user.
     • channel.suspicious_user.update - A suspicious user has been updated.
2. The following items were updated from open beta to V1:
   • Moderator Actions
     • channel.moderate - A moderator performs a moderation action in a channel.
   • VIP Add and Remove
     • channel.vip.add - A VIP is added to the channel.
     • channel.vip.remove - A VIP is removed from the channel.
   • Whisper Received
     • user.whisper.message - A user receives a whisper.
   • Channel Point Redemptions
     • channel.channel_points_automatic_reward_redemption.add - A viewer has redeemed an automatic channel points reward on the specified channel.
3. Expanded supported EventSub status messages on the following API endpoints:
   • Get EventSub Subscriptions
   • Get Conduit Shards
   • Update Conduit Shards
4. Made updates to Get User Emotes API endpoint:
   • Expanded possible values for emote_type field in response.
   • Removed broadcaster_id query parameter.

1. The following EventSub subscription types are now available in open beta:
   • Moderator Actions
     • channel.moderate - A moderator performs a moderation action in a channel.
   • VIP Add and Remove
     • channel.vip.add - A VIP is added to the channel.
     • channel.vip.remove - A VIP is removed from the channel.
   • Whisper Received
     • user.whisper.message - A user receives a whisper.
   • Channel Point Redemptions
     • channel.channel_points_automatic_reward.add - A viewer has redeemed an automatic channel points reward on the specified channel.
2. The following items were updated from open beta to V1:
   • Twitch API
     • Get User Emotes API Endpoint - Retrieves emotes available to the user across all channels.
   • EventSub Type Subscriptions
     • Unban Requests
       • channel.unban_request.create - Sends a notification when a user creates an unban request.
       • channel.unban_request.resolve - Sends a notification when an unban request has been resolved.
     • Automod
       • automod.message.hold - Notifies a user when a message is caught by automod for review.
       • automod.message.update - Sends a notification when a message in the automod queue had its status changed.
       • automod.settings.update - Sends a notification when a broadcaster’s automod settings are updated.
       • automod.terms.update - Sends a notification when a broadcaster’s automod terms are updated. Changes to private terms are not sent.
       • channel.chat.user_message_hold - Notifies a user if their message is caught by automod.
       • channel.chat.user_message_update - Notifies a user if their message’s automod status is updated.

1. Channel Chat Settings Update has moved from public beta to v1.
2. Added the following Twitch API endpoints and EventSub subscription types in open beta:
   • Twitch API:
     • Get Unban Requests - Gets a list of unban requests for a broadcaster’s channel.
     • Resolve Unban Requests - Resolve an unban request by approving or denying it.
     • Get User Emotes - Retrieves emotes available to the user.
   • EventSub subscription types:
     • Unban Requests
       • channel.unban_request.create - Sends a notification when a user creates an unban request.
       • channel.unban_request.resolve -  Sends a notification when an unban request has been resolved.
     • Automod
       • automod.message.hold - Notifies a user when a message is caught by automod for review.
       • automod.message.update - Sends a notification when a message in the automod queue had its status changed.
       • automod.settings.update - Sends a notification when a broadcaster’s automod settings are updated.
       • automod.terms.update - A notification is sent when a broadcaster’s automod terms are updated. Changes to private terms are not sent.
       • channel.chat.user_message_hold - A user is notified if their message is caught by automod.
       • channel.chat.user_message_update - A user is notified if their message’s automod status is updated.

1. The Twitch Game Engine Plugins are now generally available for building integrations in Unity, Unreal, and other C++ engines.
2.  Get Moderated Channels has moved from public beta to v1. 
3. Made the following changes to specific EventSub references in open beta:

• Events
  • Channel Guest Star Session End Event and Channel Guest Star Session Update Event:
    • Added three new fields:
      • host_user_id
      • host_user_name
      • host_user_login
    • Updated definitions for all broadcaster_* fields to reference the non-hosting streamer in a channel:
      • broadcaster_user_id
      • broadcaster_user_name
      • broadcaster_user_login
• Conditions
  • Channel Guest Star Session End Condition and Channel Guest Star Session Update Condition:
    • Updated the definition for broadcaster_user_id to refer to the non-hosting broadcaster of the channel.

• Conduits
  • Conduit event and transport method features are now generally available. See, Handling Conduit Events.
  • Updated Create EventSub Subscription to include examples for all three supported transport methods types:
    • webhook
    • websocket
    • conduit
  • Added the following Twitch API endpoints and EventSub subscription types:
    • Twitch API:
      • Create Conduits - Creates a new conduit.
      • Get Conduits - Retrieves the conduits for a client ID.
      • Update Conduits - Updates a conduit’s shard count. 
      • Delete Conduit - Deletes a conduit.
      • Get Conduit Shards - Lists all shards for a conduit.
      • Update Conduit Shards - Updates shard(s) for a conduit.
    • EventSub subscription types:
      • conduit.shard.disabled - Sends a notification when EventSub disables a shard due to the status of the underlying transport changing.
• Chat
  • Added a new Twitch API endpoint:
    • Send Chat Message - Sends a message to the broadcaster’s chat room.
  • Added new EventSub subscription type:
    • channel.chat.message - Any user sends a message to a specific chat room.

• Get Moderated Channels and channel.chat_settings.update have been added to open beta.
• user:read:moderated_channels has been added to the Twitch API scopes.

• Get Ad Schedule
  • length_seconds has been renamed to duration.
  • preroll_free_time_seconds has been renamed to preroll_free_time.
• Snooze Next Ad
• channel.ad_break.begin
  • length_seconds has been renamed to duration_seconds.

Refer to Authentication Overview and Device code grant flow for more information.

1. channel.chat.clear
2. channel.chat.clear_user_messages
3. channel.chat.message_delete
4. channel.chat.notification
   • Additionally, removed sub.cumulative_months from the event payload

• All instances of sub_plan have been renamed to sub_tier.
• For the sub and resub events, the Prime value has been removed from sub_tier.
• For the sub and resub events, a new is_prime field has been added to indicate if the subscription was purchased through Prime. Prime subs will only have a sub_tier value of 1000.
• A new badges field has been added, which returns a list of chat badges.

• Chat on Eventsub
  1. channel.chat.clear - sends a notification when a moderator or bot clears all messages from the chat room.
  2. channel.chat.clear_user_messages - sends a notification when a moderator or bot clears all messages for a specific user.
  3. channel.chat.message_delete - sends a notification when a moderator removes a specific message.
  4. channel.chat.notification - sends a notification when an event that appears in chat occurs, such as someone subscribing to the channel or a subscription is gifted.
• Ads Manager
  1. Get Ad Schedule - Returns ad schedule related information, including snooze, when the last ad was run, when the next ad is scheduled, and if the channel is currently in pre-roll free time.
  2. Snooze Next Ad - Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes.
  3. channel.ad_break.begin - sends a notification when a midroll commercial break begins on a channel.

Added the following authentication scopes for the above API endpoionts and subscription types:

1. channel:bot - Allows the client’s bot users access to a channel.
2. user:bot - Allows client’s bot to act as this user.
3. user:read:chat - View live stream chat and room messages.
4. channel:manage:ads - Manage ads schedule on a channel.
5. channel:read:ads - Read the ads schedule and details on your channel.

1. The optional is_featured field has been added to the request parameters to allow returning only featured clips, non-featured clips, or both if the parameter is not present.
2. The is_featured field has been added to the response body, indicating if the clip is featured or not.

1. The Get Users Follows API endpoint has been removed.
2. Get Channel Followers now requires the user access token to contain both the moderator:read:followers scope and have either the user ID match the broadcaster_id or the user must be a moderator for the specified broadcaster in order to return data about specific followers. This condition is also required for using the user_id parameter.
3. V1 of channel.follow has been removed.

1. The Channel Guest Star Guest Update notification now sends when a slot is updated, and includes information about the slot, if applicable.
2. The Guest Star Slot Update event has been removed, as its information is now included in the Channel Guest Star Guest Update event.
3. The moderator:read:guest_star and moderator:manage:guest_star scopes have been added to the following subscription types:
   • Channel Guest Star Session Begin
   • Channel Guest Star Session End

1. IRC Tags for PRIVMSG have been updated to include changes to Chat Replies:
   • Updated existing reply-parent-* tags to refer to only referencing their direct parent message
   • Added reply-thread-parent-msg-id
   • Added reply-thread-parent-user-login
2. Guest Star Guest Update now includes the accepted state for when a guest has accepted their invitation to the Guest Star session.

Video Broadcast updated to refer to the latest broadcasting guidelines.

1. Moved Version 2 of channel.update from open beta to generally available.
2. The following Twitch API endpoints have been decommissioned and removed from documentation:
   • “Get Soundtrack Current Track”
   • “Get Soundtrack Playlist”
   • “Get Soundtrack Playlists”
3. Increased the maximum number of enabled subscriptions per WebSocket connection from 100 to 300.

1. Made the following changes to Get Channel Information:
   • Added the content_classification_labels field to the response, which returns the CCLs currently applied to the channel.
   • Added the is_branded_content field to the response, which indicates if the channel has branded content.
2. Made the following changes to Modify Channel Information:
   • Added the content_classification_labels field to the request body, which lets you enable or disable specific content classification labels for the channel.
   • Added the is_branded_content field to the request body, which lets you specify if the channel has branded content.
3. Added the Twitch API endpoint Get Content Classification Labels, which shows you the available content classification labels.

• Removed the is_mature boolean flag
• Added a new content_classification_labels field that lists the IDs of any content classification labels applied on the channel

1. Made the following changes to Get Channel Guest Star Settings:
   • The following authentication scopes have been added
     • moderator:read:guest_star
     • moderator:manage:guest_star
   • A moderator_id is now required in the request query parameters
2. Removed the Twitch API v5 Migration Guide

• Get Channel Guest Star Settings - Gets the channel settings for configuration of the Guest Star feature for a particular host.
• Update Channel Guest Star Settings - Mutates the channel settings for configuration of the Guest Star feature for a particular host.
• Get Guest Star Session - Gets information about an ongoing Guest Star session for a particular channel.
• Create Guest Star Session - Programmatically creates a Guest Star session on behalf of the broadcaster.
• End Guest Star Session - Programmatically ends a Guest Star session on behalf of the broadcaster.
• Get Guest Star Invites - Provides the caller with a list of pending invites to a Guest Star session.
• Send Guest Star Invite - Sends an invite to a specified guest on behalf of the broadcaster for a Guest Star session in progress.
• Delete Guest Star Invite - Revokes a previously sent invite for a Guest Star session.
• Assign Guest Star Slot - Allows a previously invited user to be assigned a slot within the active Guest Star session.
• Update Guest Star Slot - Allows a user to update the assigned slot for a particular user within the active Guest Star session.
• Delete Guest Star Slot - Allows a caller to remove a slot assignment from a user participating in an active Guest Star session.
• Update Guest Star Slot Settings - Allows a user to update slot settings for a particular guest within a Guest Star session.
• channel.guest_star_session.begin - The host began a new Guest Star session.
• channel.guest_star_session.end - A running Guest Star session has ended.
• channel.guest_star_guest.update - A guest has moved between interaction states in an active Guest Star session.
• channel.guest_star_slot.update - A slot setting has been updated in an active Guest Star session.
• channel.guest_star_settings.update - The host preferences for Guest Star have been updated.

The following authentication scopes have been added:

• channel:read:guest_star
• channel:manage:guest_star
• moderator:read:guest_star
• moderator:manage:guest_star

1. Search Channels, Get Streams, Get Followed Streams — Include the following changes:
   • Added customizable tags via a new tags field.
   • Deprecated the tag_ids field in the response. The response continues to include the field; however, it will only return an empty array.
2. Get All Stream Tags and Get Stream Tags — Include the following change:
   • Deprecated the tag_ids field in the response. The response continues to include the field; however, it will only return an empty array. These endpoints will return a 410 response on July 13, 2023
3. Additionally, removed the Replace Stream Tags endpoint.

For information about these changes, see Adding customizable tags to the Twitch API.

1. Moved the following Channel Follows endpoints and subscription type from open beta to generally available:
   • Get Followed Channels — Gets a list of broadcasters that the specified user follows.
   • Get Channel Followers — Gets a list of users that follow the specified broadcaster.
   • channel.follows — Version 2 of the existing subscription type that will now require the moderator:read:followers scope.
2. Added deprecation notices to the following:
   • Get User Follows
   • channel.follows (v1)
3. Updated the Product Lifecycle with the above deprecation notice.

• Send a Shoutout — This endpoint sends a Shoutout to the specified broadcaster.
• channel.shoutout.create — This subscription type sends a notification when the specified broadcaster sends a Shoutout.
• channel.shoutout.receive — This subscription type sends a notification when the specified broadcaster receives a Shoutout.

• Get Followed Channels — Gets a list of broadcasters that the specified user follows.
• Get Channel Followers — Gets a list of users that follow the specified broadcaster.
• channel.follows (beta) — Beta version of the existing subscription type that will now require the moderator:read:followers scope.

low-trust-users has been added to PubSub reference.

1. Added the following Shoutout endpoint and subscription types to open beta:
   • Send a Shoutout — This endpoint sends a Shoutout to the specified broadcaster.
   • channel.shoutout.create — This subscription type sends a notification when the specified broadcaster sends a Shoutout.
   • channel.shoutout.receive — This subscription type sends a notification when the specified broadcaster receives a Shoutout.
2. Moved the following Charity endpoints and subscription types from open beta to generally available:
   • Get Charity Campaign Donations — Returns the list of donations that users have made to the broadcaster’s active charity campaign.
   • Get Charity Campaign — Gets information about the charity campaign that the broadcaster is running, such as their fundraising goal and the amount that’s been donated so far.
   • channel.charity_campaign.start — Sends a notification when the broadcaster starts a charity campaign.
   • channel.charity_campaign.progress — Sends a notification when the broadcaster changes the fundraiser’s target goal or when progress is made towards the goal.
   • channel.charity_campaign.stop — Sends a notification when the broadcaster stops a charity campaign.
   • channel.charity_campaign.donate — Sends an event notification when a user donates to the broadcaster’s charity campaign.

1. Moved the following Shield Mode endpoints and subscription types from open beta to generally available:
   • Get Shield Mode Status — This endpoint gets the broadcaster’s Shield Mode activation status.
   • Update Shield Mode Status — This endpoint activates or deactivates the broadcaster’s Shield Mode.
   • channel.shield_mode.begin — This subscription type sends a notification when the broadcaster activates Shield Mode.
   • channel.shield_mode.end — This subscription type sends a notification when the broadcaster deactivates Shield Mode.
2. Added the tags field to the following endpoints:
   • Get Streams
   • Get Followed Streams
   • Search Channels
   • Get Channel Information

   The tags field contains the tags that the broadcaster or Twitch added to help identify the content that the broadcaster streams.

3. Added the tags field to the Modify Channel Information endpoint to let broadcasters add or remove tags. Broadcasters use the tags to help identify the content that they stream.
4. Added the id field to the Get Charity Campaign Donations response to identify the donation.
5. Added the id field to the Charity Donation event data to identify the donation.

1. Added the following missing status values that Get EventSub Subscriptions may return in the status field. All of these statuses indicate that the subscription is now disabled. You may also use the status values to filter the list of subscriptions that Get EventSub Subscriptions returns.
   • websocket_disconnected — The client closed the connection.
   • websocket_failed_ping_pong — The client failed to respond to a ping message.
   • websocket_received_inbound_traffic — The client sent a non-pong message. Clients may only send pong messages (and only in response to a ping message).
   • websocket_connection_unused — The client failed to subscribe to events within the required time.
   • websocket_internal_error — The Twitch WebSocket server experienced an unexpected error.
   • websocket_network_timeout — The Twitch WebSocket server timed out writing the message to the client.
   • websocket_network_error — The Twitch WebSocket server experienced a network error writing the message to the client.
   • moderator_removed — The moderator that authorized the subscription is no longer one of the broadcaster’s moderators.

1. Adds the following events that you can trigger (see Testing webhook events).
   • charity-donation — Triggers an event to mimic when a user donations to the broadcaster’s charity campaign.
   • charity-start — Triggers an event to mimic when a broadcaster starts a charity campaign.
   • charity-progress — Triggers an event to mimic when progress is made towards the campaign’s goal or when the broadcaster changes the fundraising goal.
   • charity-stop — Triggers an event to mimic when a broadcaster stops a charity campaign.
2. Adds the following flags that you can use with the charity events.
   • charity-current-value — Use to specify the amount of money that’s donated for charity donation events or the current amount raised for the charity campaign events.
   • charity-target-value — Use to specify the fundraising target amount for the charity campaign events.
3. Changed the user.update event name in the documentation to user-update to match the convention used by the other events.

1. Added the Update Shield Mode Status endpoint, which activates or deactivates the broadcaster’s Shield Mode. Twitch’s Shield Mode feature is like a panic button that broadcasters can push to protect themselves from chat abuse coming from one or more accounts. When activated, Shield Mode applies the overrides that the broadcaster configured in the Twitch UX. If the broadcaster hasn’t configured Shield Mode, it applies default overrides.
2. Added the Get Shield Mode Status endpoint, which gets the broadcaster’s Shield Mode activation status.
3. Updated the status of the Get Chatters endpoint from Beta to generally available.

This release includes the following updates to the EventSub subscription types:

1. Added the channel.shield_mode.begin subscription type, which sends a notification when the broadcaster activates Shield Mode.
2. Added the channel.shield_mode.end subscription type, which sends a notification when the broadcaster deactivates Shield Mode.

• charity_name
• charity_description
• charity_logo
• charity_website

Updated the channel.charity_campaign.donate and channel.charity_campaign.progress subscription types to include the following fields:

• charity_description
• charity_website

Updated the Get Games endpoint to let you search by IGDB ID.

Added the Get Charity Campaign Donations endpoint, which returns the list of donations that users have made to the broadcaster’s active charity campaign.

Added the following subscription types to EventSub.

• channel.charity_campaign.start — Sends a notification when the broadcaster starts a charity campaign.
• channel.charity_campaign.progress — Sends a notification when the broadcaster changes the fundraiser’s target goal or when progress is made towards the goal.

• channel.charity_campaign.stop — Sends a notification when the broadcaster stops a charity campaign.

• Added version_removed as a possible status value to EventSub. The subscription’s status field is set to version_removed if EventSub stops supporting the subscribed to subscription type and version. EventSub sends the status in a revocation message.

1. Updated the CLI’s Generating Mock Data and Starting the Server topic to remove the erroneous user_id parameter from the table under Getting an app access token.

2. Updated the Get Hype Train Events endpoint to include the following new contribution type:

   • OTHER — Covers contribution methods other than Bits and Subscriptions. See the type field under the last_contribution and top_contributions fields.

   Updated the begin, progress, and end Hype Train events to include the following new contribution type:

   • other — Covers contribution methods other than Bits and Subscriptions. See the type field under the last_contribution and top_contributions fields.

3. Added the Broadcast Scheduling Guide.

• charity_name — The charity’s name.
• charity_logo — A URL to the charity’s logo.

Updated the Twitch CLI to support testing your WebSocket client (you’ll need to upgrade to the latest version). The server sends the client a welcome message followed by ping and keepalive messages. You’ll mostly use the mock server to send a reconnect message to test your client’s reconnect code flow. For details, see the start-websocket-server sub-command.

Updated the Transport object that you use to subscribe to events:

• Added websocket as a possible value to the method field.
• Require the callback field only if the method field is set to webhook.
• Require the secret field only if the method field is set to webhook.
• Add the session_id field, which identifies the WebSocket to send notifications to. This field is required only if the method field is set to websocket.
• Added the connected_at field, which contains the UTC date and time that the WebSocket connection was established. This is a response-only field that Create EventSub Subscription and Get EventSub Subscription returns if the method field is set to websocket.
• Added the disconnected_at field, which contains the UTC date and time that the WebSocket connection was lost. This is a response-only field that Get EventSub Subscription returns if the method field is set to websocket.

The id field of the Charity Donation Event object will change to campaign_id to better reflect its content on Tuesday, September 20 at 1:00pm PDT.

• bits_voting_enabled
• bits_per_vote

If your request includes these fields, the endpoint ignores them. The following response fields will be set to default values.

• bits_votes — set to 0.
• bits_voting_enabled — set to false.
• bits_per_vote — set to 0.

The Get Polls and End Poll responses will show the above values for polls created on or after August 29, 2022; otherwise, the response contains Bits values if enabled.

The above Bits-related fields should also be ignored for the following EventSub events:

• channel.poll.begin
• channel.poll.progress
• channel.poll.end

• Get Charity Campaign — Gets information about the charity campaign that the broadcaster is running, such as their fundraising goal and the amount that’s been donated so far.
• channel.charity_campaign.donate — Sends an event notification when a user donates to the broadcaster’s charity campaign.

• Creating Clips — Shows how to create and get clips.
• Creating Markers — Shows how to create and get stream markers.

Updated the list of possible values that the type field in the Get Creator Goals API response may be set to. The following values were added to the list:

• subscription_count — The goal is to increase subscriptions. This type shows the net increase or decrease in the number of subscriptions.
• new_subscription_count — The goal is to increase subscriptions. This type shows only the net increase in the number of subscriptions (it does not account for users that unsubscribed since the goal started).

• Send Chat Announcement — Sends an announcement to the broadcaster’s chat room.
• Delete Chat Messages — Removes a single chat message or all chat messages from the broadcaster’s chat room.
• Update User Chat Color — Updates the color used for the user’s name in chat.
• Get User Chat Color — Gets the color used for the user’s name in chat.
• Add Channel Moderator — Adds a moderator to the broadcaster’s chat room.
• Remove Channel Moderator — Removes a moderator from the broadcaster’s chat room.
• Get VIPs — Gets a list of the channel’s VIPs.
• Add Channel VIP — Adds a VIP to the broadcaster’s chat room.
• Remove Channel VIP — Removes a VIP from the broadcaster’s chat room.
• Send Whisper — Sends a whisper message to the specified user.

The following authentication scopes have also been added for the endpoints above:

• moderator:manage:announcements
• moderator:manage:chat_messages
• user:manage:chat_color
• channel:manage:moderators
• channel:read:vips
• channel:manage:vips
• user:manage:whispers

Twitch Drops - Japanese localization added.

• Deprecated and removed the user_id field from the request body. The endpoint ignores the field if you include it.
• Added endpoint-specific rate limits.

For information about these changes, see Upcoming changes to the Check AutoMod Status API.

Get Users — Includes the following change:

• Deprecated the view_count field in the response. The response continues to include the field; however, it contains stale data. You should stop displaying this data at your earliest convenience.

Start a Raid, Cancel a Raid — Includes the following change:

• These endpoints were removed from Beta and are now generally available (replaced the Beta tag to New).

Get EventSub Subscriptions — Includes the following change:

• Added the user_id query parameter that you can use to filter your list of subscriptions by. The response contains subscriptions where the user ID matches a user ID that you specified in the Condition object when you created the subscription.

BREAKING CHANGES

Get Soundtrack Playlist — Removed the following playlist fields from the response:

• description
• id
• image_url
• title
• tracks (the data field now contains the playlist’s tracks)

Get Soundtrack Playlists — Added the id query parameter, which you can use to get metadata information about a single playlist.

This update adds the following endpoints:

• Start a Raid
• Cancel a Raid

Added the created_at field to the response object of the following endpoints:

• Ban User
• Get Banned Users

• user.update — Added the email_verified field, which indicates whether Twitch has verified the user’s email.
• channel.ban — Added the banned_at field, which indicates the UTC date and time of when the user was banned or put in a timeout.
• channel.hype_train.begin — Added the level field, which indicates the level at which the Hype Train started.

Extension Guidelines and Policies - Added section 4.11 regarding NFTs in Twitch Extensions.

• Added a section for content in Extensions
• Amended the quicker reviews section with information regarding what types of domains are valid for an Extension’s content security policy allowlists.

Extension Guidelines and Policies

• Added section 4.10 regarding global overlay Extensions. See more details in our announcement.
• Added section 2.13 to regarding what types of domains are valid for an Extension’s content security policy allowlists

Added information about when the Twitch API may introduce breaking and non-breaking changes to the API. For details, see Breaking Changes.

Get Hype Train Events - Removed id query parameter. See the deprecation announcement for more information.

• Replaced the /r9kbeta and /r9kbetaoff Twitch chat commands to /uniquechat and /uniquechatoff, respectively, to match the commands used in Twitch Chat. The /r9kbeta and /r9kbetaoff continue to work but you should start using /uniquechat and /uniquechatoff at your earliest convenience.

• Removed the following tags from the list of possible USERNOTICE tags:

  • anonsubgift
  • anonsubmysterygift

• Added the WHISPER command to the list of commands that the Twitch IRC server may send your bot.

• Changed the description for the broadcaster_id query parameter to indicate that you may specify a maximum of 100 IDs.

Get Soundtrack Current Track endpoint

• Changed the description for the data response field to remove the part that states that the list is empty if the broadcaster is not playing a track. The correct behavior is that if the broadcaster is not playing a track, the endpoint returns HTTP status code 404 Not Found.
• Changed the description for the creator_channel_id response field to indicate that its value is an empty string if a Twitch user didn’t create the track instead of null.

Get Soundtrack Playlist endpoint

• Changed the description for the creator_channel_id response field to indicate that its value is an empty string if a Twitch user didn’t create the track instead of null.

Extension Policy 2.9 updated to clarify that the Twitch Extension Helper must be included as the first script in all front-end HTML files.

Moderation API endpoints have moved from public beta to generally available.

• Goals Event
• Get Creator Goals

• Set the follower_mode_duration field to any value between 0 and 129600, inclusive.
• Set the slow_mode_wait_time field to any value between 3 and 120, inclusive.

Open beta changes:

• For Ban Users, bulk requests have been removed until a more scalable solution is available.
• For Ban Users and Unban User, error message formatting now utilizes the same structure as other API endpoints since bulk requests have been removed. HTTP 429 errors may also be returned if there are too many requests even within normal Twitch API rate limits.

1. Get Soundtrack Current Track — Gets the Soundtrack track that the specified broadcaster is playing.
2. Get Soundtrack Playlists — Gets the list of Soundtrack playlists.
3. Get Soundtrack Playlist — Gets the specified Soundtrack playlist.

Updates Product Lifecycle to include the deprecation of a few Twitch API endpoints that supported WebSub-based webhooks.

Explicitly including the “Content-Type: application/json” header in API reference examples.

Get started with Twitch Extensions - “Restrictions on content” section updated to reflect Extensions policy 2.12 and the timeline mentioned in the announcement.

Retitled the “Get Live Channels” to “Get Extension Live Channels” to clarify the endpoint is specific to Extensions activated on live channels.

• Removed the Get Webhook Subscriptions endpoint from the reference.
• Deleted the Webhooks Guide and Webhooks Reference topics.
• Updated the Product Lifecycle topic to note the date that WebSub-based webhooks was decommissioned.

Insights & Analytics – Directions to access Drops Analytics has been updated and the “Top Streamers” report has been removed.

Embedding Twitch - Updated to include that certain features may be disabled if the embedded iframe is obscured.

Embedding Video and Clips - Updated description for seek function and added the SEEK event.

Updated Extension Helper Library to clarify that all HTML files should include the Extension Helper.

• format — The formats that the emote is available in. For example, PNG or animated GIF.
• scale — The sizes that the emote is available in. For example, 1.0 (small).
• theme_mode — The background themes that the emote is available in. For example, light.
• template — The URL template that you use to create a URL for fetching the emote.

For information about how to use these fields, see Twitch Emotes.

Added the following to the Chatbots & IRC Guide.

• Existing site-wide rate limit for verified bots
• Clarification in the JOIN section regarding expected behavior when exceeding rate limits for joining channels

Twitch Emotes Guide - Added to document how developers can customize Twitch Emote image URLs to optimize their rendering in third-party applications.

With the addition of the guide above, the “Chatbots & IRC” navigation item has been retitled to “Chat & Chatbots” to include a broader range of chat topics.

The following Extension-related Twitch API endpoints have been added:

• Get Extension Configuration Segment
• Set Extension Configuration Segment
• Set Extension Required Configuration
• Send Extension PubSub Message
• Get Extension Live Channels
• Get Extension Secrets
• Create Extension Secret
• Send Extension Chat Message
• Get Extensions
• Get Released Extensions
• Get Extension Bits Products
• Update Extension Bits Product

Get Drops Entitlements - Updated to include fulfillment_status.

Update Drops Entitlements - Added to the Twitch API reference.

User Authorization Grant EventSub subscription type added as v1.

Drops guide - Minor changes and updates regarding the additions above.

Update regarding the temporary pause of chatbot verification added to the Twitch Chat Guide.

EventSub - Channel Subscription End Event added tier and is_gift.

Authentication - The existing user:read:email scope has been added.

• Get Channel Stream Schedule
• Get Channel iCalendar
• Update Channel Stream Schedule
• Create Channel Stream Schedule Segment
• Update Channel Stream Schedule Segment
• Delete Channel Stream Schedule Segment

Channel Subscription Message has moved from public beta to v1.

Get Videos updated to explicitly mention the 500 results limit when specifying game_id.

• Get Channel Emotes
• Get Global Emotes
• Get Emote Sets

Extension Bits Transaction Create EventSub subscription type has moved from public beta to version 1.

AutoMod Queue and User Moderation Notifications PubSub topics - Examples updated for accuracy.

Several GitHub Issues resolved for documentation.

• Get Channel Chat Badges
• Get Global Chat Badges

EventSub subscription type updates.

• Channel Subscription End has moved from public beta to v1. This was previously known as “Channel Unsubscribe.”
• Channel Subscription Gift has been added as a public beta.

Polls and Channel Points Predictions EventSub subscription types have moved from public beta to version 1.

AutoMod Queue and User Moderation Notification topics added to PubSub reference.

Channel Points Custom Rewards - The API reference for Custom Rewards endpoints has been updated for consistency and to clarify conditional requirements for body parameters. For example, max_per_stream is required if a value for is_max_per_stream_enabled is also provided.

Channel Prediction End EventSub subscription type - removed the locked_at field due to edge cases with Predictions that are cancelled or closed early.

Create EventSub Subscription and Get EventSub Subscriptions - limit removed following the new EventSub subscription limit cost-based system.

Get Channel Information - Added delay to return values table and example payload.

Authentication - moderator:manage:automod scope added for Manage Held AutoMod Messages.

This entry has been updated, the subscription type has been renamed from “Channel Unsubscribe” to “Channel Subscription End” after moving from beta to v1.

• Get Polls
• Create Poll
• End Poll
• Get Predictions
• Create Prediction
• End Prediction

EventSub subscriptions types added for polls and Channel Points Predictions as a public beta.

• Channel Poll Begin
• Channel Poll Progress
• Channel Poll End
• Channel Prediction Begin
• Channel Prediction Progress
• Channel Prediction Lock
• Channel Prediction End

EventSub Subscriptions Types - Added information regarding the expected availability of EventSub subscription types when released as a public beta.

Embedding Twitch - Minor documentation updates.

Authentication - user:read:follows scope added for Get Followed Streams.

v5 Migration Guide - Updated to mention Get Followed Streams equivalence.

New API response fields added

• Get Streams: is_mature
• Get Clips: duration
• Search Channels: game_name
• Get Videos: stream_id
• Get Videos: muted_segments array of objects with duration and offset

Update User - Clarifying why description is optional and what results if not provided.

Extensions Reference - Parameter tables reordered to match the order they should be passed into their respective functions.

Other minor corrections.

Added associated Twitch API endpoints to the scopes section of the Authentication guide.

Minor design improvements.

• The maximum value for the number of items return via the first parameter has been increased to 1000.
• Pagination updated for accuracy in the the return values table and the example payload.

Webhooks example payloads updated for accuracy.

Miscellaneous corrections.

EventSub’s cost-based system for subscription limits has been added. Thanks for the feedback on RFC 0014.

Improved the instructions and information regarding the creation of Twitch applications for Drops campaigns.

Several documentation corrections received through GitHub Issues have been resolved.

• Get Channel Teams has been added to the API reference.
• Get Teams has been added to the API reference.
• The v5 migration guide has been updated to include the new Get Teams endpoint.

EventSub

• The Channel Raid subscription type has been moved from beta to v1.
• The Channel Moderator Add and Channel Moderator Remove subscription types have been added as a public beta.

• Added clarification in steps 4-5 on “Create a subscription.”
• Channel Follow now includes the timestamp of when the follow occurred.
• Clarified the id field in the EventSub Stream Online notification payload.

The following endpoints were updated to use the channel:manage:broadcast scope. The previous scope remains valid.

• Modify Channel Information
• Create Stream Marker
• Replace Stream Tags

Updated the v5 Video Upload Guide introduction for visitors looking for information regarding uploads via the Creator Dashboard.

Fixed broken links in chat references.

Removed the “Create Entitlement Grants Upload URL” Twitch API endpoint associated with a previous version of Twitch Drops.

Scope for Channel Subscriptions in PubSub has been updated to channel:read:subscriptions. Previous scope remains valid.

Channel Points Hackathon banner added.

Further clarification for game_id and title added for Modify Channel Information.

Minor updates to the API guide and Chat guide.

EventSub Channel Unban v1 now includes moderator information.

Section 7.5 of the Extensions Guidelines and Policies has been removed following the original announcement.

Updated Get Users to correctly document created_at in the example.

Minor editorial updates to the Extensions Monetization Guide.

A message regarding the deprecation of Twitch Quarterly Insights has been added to Insights following the recent announcement.

Explicitly stating in Extensions that files should be zipped together as opposed to zipping the directory containing the files.

Miscellaneous UserVoice and GitHub Issues addressed.

• The Channel Raid subscription type has been added as a public beta.
• The started_at timestamp has been added to the Stream Online Event.

A note about removing Extensions Policy 7.5 has been added since Twitch Extensions no longer load for banned users.

The Drops guide now includes a section regarding thoughtful naming of campaigns and rewards.

Product Lifecycle has been updated to include definitions for tagging functionality in the documentation.

• GET helix/bits/leaderboard
• GET helix/channel_points/custom_rewards
• PATCH helix/channel_points/custom_rewards
• POST helix/channel_points/custom_rewards
• GET helix/channel_points/custom_rewards/redemptions
• PATCH helix/channel_points/custom_rewards/redemptions
• GET helix/extensions/transactions
• GET helix/moderation/banned
• GET helix/moderation/banned/events
• GET helix/moderation/moderators
• GET helix/moderation/moderators/events
• GET helix/search/channels
• GET helix/streams
• GET helix/streams/markers
• GET helix/videos
• GET helix/users/follows

• Corrected status value in examples.
• Clarified requirements for secret.

Authentication updates:

• Correctly state a 400 Bad Request is returned when attempting to revoke an invalid token, rather than a 200 OK.
• Scope information corrections and updates.

Additional updates:

• offset removed from Get Channel Followers endpoint in v5 as it is no longer supported. cursor should be used for pagination.
• Extensions tutorial updated to use Gists instead of image.
• Several UserVoice suggestions and GitHub Issues addressed.

• Get Channel Editors
• Delete Videos
• Get User Block List
• Block User
• Unblock User

The new scopes for these endpoints have also been added to Authentication. Updated the descriptions of existing scopes for consistency and accuracy.

• channel:read:editors
• channel:manage:videos
• user:read:blocked_users
• user:manage:blocked_users

v5 migration guide updates:

• New v5 scope mappings have been added for the above endpoints. See channel_editor, channel_read, user_blocks_read, and user_blocks_edit.
• Five endpoint equivalence definitions have been added for the above endpoints.

giantbomb_id set to 0 in the v5 Get Top Games response example to reflect a game data migration.

• Added support for filtering by type.
• Added user login to notification payloads.

Added twitch://broadcast mobile deeplink to broadcast a specific category.

Embed updates:

• enableCaptions() function, disableCaptions() function, and Twitch.Player.CAPTIONS event added.
• sandbox added for embedded chat.
• getPlaybackStats() function and a description of the PlaybackStats object added back into the documentation.
• autoplay documentation updated to note the default value is false.
• Removed frameborder and scrolling from Twitch embed examples as these were deprecated in HTML5.

Feedback and bug reports:

• Bring back a function similar to .getPlaybackStats()
• Channel Update Notification Example Contradicts Channel Update Event Documentation
• Typo in “Chatbots & IRC Guide” section and typo
• Google Analytics in extensions: example not up to date with GA changes
• Typo in EventSub Guide page
• Unclear Mention of Regex for Bits Parameter
• [TYPO] EventSub channel.update docs
• Deprecated attribute

Updated JavaScript helper examples to use window.Twitch.ext.

Clarifcation for linking accounts for time-based Drops.

Miscellaneous API reference fixes.

• Further documenting endpoints that support first and after
• “Get Users” now mentions an app access token can be used
• user:read:email corrected to be optional
• broadcaster_name documented for “Get Channel Information”
• Backend typo
• Subscriptions webhook link fixed
• usage_untimeout correction
• OAuth procedure links are clickable
• Possible typo for separating scopes
• Fixed example payload for Get All Chat Emoticons
• Added clarification for expected language query parameters and response values
• Fixed link to configuration service reference

Miscellaneous fixes:

• Removed duplicate search results
• Displaying more search results
• Provided the full accept header in the v5 “Requests” section
• Changed the date format in the changelog to YYYY-MM-DD

Updated Drops Analytics image.

Changed type for pagination response field to be “object containing a string”.

Corrections and edits to scopes documentation.

Added Channel Points API to the API Reference.

Added a v5 to Twitch API migration guide.

API Reference:

• Corrected token requirement for Get Stream Tags.
• Made sub-section ordering consistent, listing query parameters before body parameters.
• Corrected Modify Channel Information documentation which had body parameters listed as query parameters.

Pub Sub:

• Updated user notices for multi-month subscriptions.
• Added sample code for multi-month subscriptions.
• Updated the topic for chat moderator actions.

• Fixed issue causing apostrophes to show as random characters.
• Removed duplicate entry for Get Stream Tags.

Authentication Guide:

• Added maximum OAuth token limits.
• Added channel:read:redemptions scope.
• Corrected the spelling of channel:manage:broadcast.

Clarified instructions for supplying parameters in the Webhooks Reference.

Clarified limits in the Webhooks Guide.

In the Extensions Guide, corrected the environment variable HTTPS=true for create-react-app.

• Made example code consistent.
• Eliminated duplicate entry for the Get Stream Tags endpoint.
• Fixed typos.

Fixed a typo in the channel:manage:broadcast scope.

Removed the Glossary.

Edited and redesigned the top-level page:

• Fixed broken links.
• Added links to UserVoice and GitHub for feedback and support.
• Removed outdated screenshots.
• Removed redundant links.

Added to the Get Clips endpoint documentation that clips are returned sorted by view count, in descending order.

• Get Code Status
• Redeem Code

Updated Extensions documentation to say that layout needs to accommodate variable height rather than fixed at 700 pixels.

Clarified language in the Create Clip endpoint documentation.

Removed documentation for chat rooms, because the feature is deprecated.

Removed the deprecated information about rate limits when there is no token from the API Guide.

Added pagination information to the Get Drops Entitlements endpoint documentation.

Changed documentation of Start Commercial response field from retryAfter to retry_after.

• Get Stream Key
• Get Channel Information
• Modify Channel Information
• Delete User Follows
• Get Hype Train Events

• Get Channel Information
• Modify Channel Information
• Search Channels
• Search Categories
• Get Stream Key
• Start Commercial
• Create User Follows
• Delete User Follows
• Get Cheermotes

Added new functionality to the API: the Hype Train API.

API Reference: Updated all example requests to include Client ID and token in Authorization header, as per new OAuth requirement.

Updated the Authentication Guide to include new OAuth scopes. 

Updated the Webhooks Reference to show that authorization is now required authorization for every web hook.

• Commerce Best Practices 
• Bits Best Practices

Updated the Extensions Guidelines and Policies page for Content and Commerce.

• Get Channel Communities
• Set Channel Communities
• Delete Channel from Communities

Corrected URL for Get Extension Transaction endpoint.

• Added new parent parameter.
• Removed deprecated getPlaybackStats method.
• Removed references to the font-size option for everywhere embeds.

• v5 Get Live Streams
  • Removed _total field
  • Documented that the offset is capped at 900
• v5 Get Followed Streams
  • Removed _total field
  • Documented that the offset is capped at 900

Edited the Get Game Analytics endpoint to note that we only return data for the previous 365 days.

Updated documentation for the sunset of Premieres.

Documented the isBitsEnabled feature flag in the Extensions Reference.

Removed the link to the deprecated form to increase webhook subscription limits.

Added gifter_id and gifter_name fields to the Get Broadcaster Subscriptions endpoint and webhook.

• Added Chat feature
• Added Required Scope for channel-bits-events-v1 and channel-bits-badge-unlocks
• Removed channel-commerce-events-v1 because it is deprecated

• Updated description of Subscribe / Unsubscribe call to be more accurate about response codes and authentication required.
• Small syntax / formatting tweaks in the JSON examples.
• Mention the authenticated scopes needed for various authenticated webhooks.

Webhooks Guide

• Clarified how retries are performed and how we handle non-2xx response codes from clients.
• Provided insight into the implementation of a handler for verification according to the W3C websub spec.

• https://dev.twitch.tv/docs/extensions/#hello-world
• https://dev.twitch.tv/docs/extensions/rig/

Merged Get Broadcaster’s Subscribers into Get Broadcaster Subscriptions because they both return the subscribers to a channel. 

Added Load Testing Extensions Using Locust and Elastic Beanstalk document.

Added Submission Best Practices for Extensions.

Removed “Increasing Feedback in Extensions”.

Updated Extensions: Developer Rig

Updated Extensions: Increasing Feedback in Your Extension.

Updates to “Extensions: Designing” guide.

Updated all “Embed” docs (Introduction, Embed Chat, Embed Video & Clips, & Embed Everything).

Added documentation for Subscription Events webhook.

Documented two new webhooks:

• Moderator Change Events
• Channel Ban Change Events

Changes to Helper Bits in the Extensions Reference:

• The field should be “exp” rather than “expires”.
• Documented the domainID object.
• Edited definition of the product object.

• Added policy 6.2.8.

Added Extension Transaction Created to the Webhooks Reference.

Fixed date errors in the changelog.

Updated Configuration Service documentation.

Removed Topic: Extension Analytics and Topic: Game Analytics from the Webhooks Reference because the endpoint is returning invalid data.

Extensions Guidelines & Policies:

• Added policies 1.5, 3.4, and 4.6.2.
• Appended 4.3 to mention Emotes usage and beta program.
• Appended 4.4 to mention advertising beta program.
• Removed 4.6.1 (Off-site links must be related to the extension’s core functionality).
• Removed 4.6.3 (Off-site links must be included within your URL allowlist).
• Previous 5.2 and 5.3 reworked and appended to mention the commerce beta program.

Updated the v5 API Reference to indicate that the version is deprecated.

Extensions Monetization Guide{: target=”_blank” (formerly Bits in Extensions), Extensions Life Cycle Management: Added Monetization tab to Extensions manager, for selecting Bits support and/or new subscription status support, and for going to the monetization onboarding process.

Bits: Small edits to documentation, for clarity.

New Twitch API Reference: Added new endpoints: Get Broadcaster Subscriptions and Get User Subscriptions.

Getting Started with Extensions: Clarified using the native Developer Rig (beta).

Mobile Deep Links: Added deep links for category tags and live-stream tags.

Insights & Analytics: Several clarifications, based on user feedback. Revised definitions of data fields that use device IDs. New section on “Counting Device IDs.”

Chatbots & IRC Guide: Added scopes for /vip, /unvip, and /vips commands.

Chatbots & IRC: Twitch Tags: In USERNOTICE, added anonsubgift.

PubSub Guide: Added sample message for anonsubgift.

Extensions Reference: New JWT schema field, is_unlinked.

New Twitch API Reference: New description and example in Get Webhook Subscriptions, which requires a Bearer token.

Building Extensions: Added information about pre-release disclosures. 3/7/19 update: Moved to Extensions Life Cycle Mangement.

New Twitch API Guide: New information in “Rate Limits.”

Getting Started with Extensions: Added the new Extensions Developer Sandbox.

• Extensions Developer Rig: The rig no longer requires prior onboarding.
• Bits in Extensions Guide: A new onboarding procedure is described.

• Building Extensions: New “Configuration Service” section.
• Extensions Reference:
  • Three new endpoints (Set Extension Configuration Segment, Get Extension Channel Configuration, Get Extension Configuration Segment).
  • New Twitch Extensions configuration helper functions (see “Helper: Configuration”).
  • Change to when Set Extension Required Configuration can be used.
• Extensions Developer Rig: New Configuration Service tab.
• Releasing & Maintaining Extensions: Many updates. 3/7/19 update: Renamed Extensions Life Cycle Management.

Insights & Analytics: Added printing a poster view of Twitch Quarterly Insights.

Webhooks Reference: Clarified the functionality of the Stream Changed webhook (formerly called Stream Up/Down).

Extensions Reference: New hostingInfo property in the onContext JS helper function. New onHighlightChanged JS helper function.

Apps & Authentication Guide: The chat_login scope is deprecated. See the section on new scopes for chat and PubSub.

Chatbots & IRC Guide: New section on Scopes for IRC Commands.

Mobile Deep Links: New section on launching the Twitch app with universal links (recommended).

Extensions Reference: Added Send Extension Chat Message endpoint and Helper: Feature Flags (JS helper functions).

• If you have released a mobile extension: Your extension no longer appears on iOS. Twitch will contact you soon about adding iOS support.
• If you develop a new mobile extension for iOS, please set up an Apple developer account (if you do not already have one), then contact Twitch (developer_support@twitch.tv) to add iOS support.

Extensions Reference: In Helper: Extensions, added new property (arePlayerControlsVisible) to the onContext JS helper function.

New Twitch API Reference: Updated the Get Extension Analytics endpoint for V2.

New Twitch API: Webhooks Reference: Added new webhook, Extension Analytics.

Extensions Guidelines & Policies: Added Bits in Extensions requirements.

Extensions Guidelines & Policies: Added a note about which versions of Android and iOS must be supported by mobile extensions.

Extensions Reference: Added two new fields to the onContext JS helper function (isMuted, volume).

Apps & Authentication: Split this large document into several smaller docs, to make it easier to read and find information.

New Twitch API Reference: Updated the Get Game Analytics endpoint, to enable selection of report version and date/time range.

Chatbots & IRC Guide: Updated the information on “Connecting to Twitch IRC.”

Building Extensions: In “Local Test,” added information about the new Invite Only tab, for seeing allowlisted extensions in the Extensions Manager.

New Twitch API Reference: Added three endpoints: Get User Extensions, Get User Active Extensions, Update User Installed Extensions.

Apps & Authentication: Added new scopes, for new endpoints.

Embedding Twitch: Everything: For the layout parameter, changed the valid value from video-and-chat to video-with-chat.

Twitch API v5: In “Which API Version Can You Use?” indicated that there is no scheduled deletion date for v5.

Drops Guide: In “Next: Notify the Viewer about Drops,” added GUID to URLs.

• Getting Started with Extensions: Added links to new videos.
• Getting Started with Chatbots & IRC: New doc.
• Getting Started with the New Twitch API: New doc.

Extensions Reference: Changes to Send Extension PubSub Message (messages can be sent globally), listen and send JS Helper functions, and Example JWT Payload.

New Twitch API: Webhooks Reference: Added two webhooks (User Changed, Game Analytics).

Insights & Analytics: New doc, with information on both game developer analytics and extensions developer analytics. (Replaces the Game Developer Analytics doc.)

Extensions Reference: The onVisibilityChanged JS helper function now works with component extensions.

• In Create Clip, an optional query string parameter was added, has_delay. This adds a delay before the clip is captured to account for the brief delay between the broadcaster’s stream and the viewer’s experience of that stream.

Extensions Guide: Video-component extensions were added. Broadcasters can activate up to six extensions at a time: 3 panel, 1 video overlay (full screen), and 2 video component (smaller).

Extensions Reference: Info was added about video-component extensions (new JS Helper function, onPositionChanged).

New Twitch API Reference: In Get Clip, 4 query params were added (broadcaster_id, game_id, before, after).

New Twitch API Reference: A “Resource” column was added to the summary table of endpoints, then endpoints in the doc were re-ordered to match the table (so endpoints for the same resource are in the same part of the doc).

Embedding Video and Clips: In “Interactive Frames for Live Streams and VODs” > “Events Emitted by and Defined by the Player,” a new PLAYING event was added and the definition of the PLAY event was changed.

Extensions Guide: In “Appendix B: Guidelines and Practices,” the policy for audio was revised: “Extensions can include audio only if they include controls which allow viewers to adjust the volume, and by default, these controls are set to off/muted.” 5/2/18 update: Now that the Extensions Guide is split up, this information is in Extensions Guidelines & Policies.

Extensions Reference: Changes related to the introduction of dynamic anchors. Search for “anchor” in the doc.