https://github.com/0-vortex/twitch-changelog-parser
Check https://dev.twitch.tv/docs/change-log every 6 hours and create commits with changes
https://github.com/0-vortex/twitch-changelog-parser
Last synced: 12 months ago
JSON representation
Check https://dev.twitch.tv/docs/change-log every 6 hours and create commits with changes
- Host: GitHub
- URL: https://github.com/0-vortex/twitch-changelog-parser
- Owner: 0-vortex
- Created: 2021-07-01T22:55:03.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T18:03:20.000Z (about 1 year ago)
- Last Synced: 2025-04-11T19:25:41.469Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 539 KB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# twitch-changelog-parser
[](http://commitizen.github.io/cz-cli/)
[](https://github.com/0-vortex/twitch-changelog-parser/actions/workflows/download.yml)
## Changelog
### 2025‑06‑13
V1 of the following EventSub subscriptions have been deprecated and V2 versions are now available for migration:
- 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.
### 2025‑05‑23
The Twitch Drops Guide has been updated to include additional high-level information about Drops, expanded FAQs, and a separate Campaign Guide and Technical Guide.
### 2025‑05‑09
This release includes the following updates:
-
Get EventSub Subscriptions has been updated to include the newsubscription_idparameter 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.
### 2025‑04‑17
Updated description of Send Chat Message API and its for_source_only parameter to clarify how chat messages are sent depending on token type.
### 2025‑04‑15
Following deprecation of PubSub, PubSub Guide has been replaced with Legacy PubSub to EventSub Migration Guide.
### 2025‑04‑10
This release includes the following updates:
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:
- Updated EventSub subscription:
- Channel Chat Message
-
channel.chat.messsage - Any user sends a message to a specific chat room.
-
- Channel Chat Message
- Updated API:
- Send Chat Message
-
Send Chat Message - Sends a message to the broadcaster’s chat room.
-
- Send Chat Message
- 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.
-
-
### 2025‑03‑18
This release includes the following updates:
- 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.
-
- 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.
-
### 2025‑02‑27
This release includes updates to the following EventSub subscription types:
-
Channel Bits Use - Updated from open beta to V1. -
Channel Points Automatic Reward Redemption Add V2 - Updated from open beta to V2.
### 2025‑02‑19
This release includes the following updates for Twitch API endpoints and EventSub subscription types:
-
Channel Bits Use - Added the following parameters:
emote_set_idowner_idformat
-
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
-
### 2025‑02‑12
The following V2 EventSub subscription type is now available in open beta:
-
channel.channel_points_automatic_reward_redemption.add - A viewer has redeemed an automatic channel points reward on the specified channel.
### 2025‑02‑06
The following EventSub subscription type is now available in open beta:
-
Channel Bits Use - A notification is sent whenever Bits are used on a channel.
### 2025‑01‑30
Added Legacy PubSub to EventSub Migration Guide.
### 2025‑01‑21
Send Chat Announcement now includes response code 429 (Too Many Requests) in its Response Codes section.
### 2025‑01‑13
Get Clips has been updated to reflect the maximum number of results to be returned over multiple paginated requests.
### 2024‑12‑05
This release includes the following updates:
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.
### 2024‑12‑04
The Twitch Drops Guide has been updated to include information regarding subscription-based Drops, now available for all game developers.
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.
### 2024‑11‑25
This release includes the following updates:
- Added information about the Game Maker version of the Twitch Game Engine Plugins
### 2024‑11‑21
This release includes the following updates:
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.
### 2024‑11‑12
This release includes the following updates:
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.
### 2024‑11‑01
Get Content Classification Labels and Modify Channel Information have been updated to support the new Content Classification Label, “Politics and Sensitive Social Issues.”
### 2024‑09‑16
This release includes the following updates:
- 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.
-
- Shared Chat
- 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.
-
- Get Shared Chat Session
### 2024‑09‑10
This release includes the following updates:
- Updated IRC PRIVMSG tags to include the following new tags:
source-room-idsource-idsource-badgessource-badge-info
- 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
sharedchatnoticeto the existingmsg-idtag
- Introduced new tag
- Added Shared Chat section to IRC Concepts, detailing the handling of Shared Chat on IRC
### 2024‑09‑06
This release includes the following updates:
- 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.
-
- Shared Chat
- 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.
-
- Get Shared Chat Session
- The following EventSub subscription types have been updated:
- Chat Message
- Chat Notification
- Chat Moderate V1 and V2
- Chat Message
### 2024‑08‑01
This release includes the following updates:
- 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.
- 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
### 2024‑07‑11
This release includes the following updates:
- 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.
-
- Channel Warnings
- 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.
-
- Moderator Actions
- 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.
-
- Warn Chat User
- 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.
-
### 2024‑07‑09
This release includes the following updates:
- 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.
- Added policy 3.5 to Extensions Guidelines & Policies.
### 2024‑06‑19
This release includes the following updates:
- 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 frombetato2in a future release.
-
- Channel Warnings
-
channel.warning.acknowledge - A user acknowledges a warning. -
channel.warning.send - A user is sent a warning.
-
- Moderator Actions
- 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.
-
- Warn Chat User
### 2024‑06‑13
This release includes the following updates:
-
Channel Chat Message:
- The following enum values for the
message_typefield have been changed:
-
animatedhas been renamed topower_ups_message_effect -
gigantified_emotehas been renamed topower_ups_gigantified_emote
-
- The following enum values for the
-
Automatic Point Redemption Add:
- The following enum values for the
reward_typefield have been changed:
-
send_animated_messagehas been renamed tomessage_effect -
send_gigantified_emotehas been renamed togigantify_an_emote
-
- The following enum values for the
### 2024‑06‑11
This release includes the following updates:
- General improvements made to Unity Guide
- Fixed Typos
- General code improvements
- General rewording to improve readability
- Updated unitypackage to include experiemental Mac support
### 2024‑05‑22
This release includes the following updates:
-
Channel Chat Message now supports:
- A new field:
channel_points_animation_id
- The following new enum values for the
message_typefield:
- animated
- gigantified_emote
- A new field:
-
Automatic Point Redemption Add now supports:
- The following new enum values for the
reward_typefield:
- send_animated_message
- send_gigantified_emote
- celebration
- The following new enum values for the
### 2024‑04‑22
This release includes the following updates:
- All Goal Subscription EventSub events were updated to include two new goal
typevalues:
- new_bit
- new_cheerer
### 2024‑04‑12
This release includes the following updates:
- 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.
-
- Low Trust User (Suspicious User)
- Made updates to Get User Emotes API endpoint:
- Re-added
broadcaster_idquery parameter. The description of this query parameter was updated to reflect it’s purpose.
- Re-added
### 2024‑04‑05
This release includes the following updates:
- 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.
-
- Low Trust User (Suspicious User)
- 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.
-
- Moderator Actions
- Expanded supported EventSub status messages on the following API endpoints:
- Made updates to Get User Emotes API endpoint:
- Expanded possible values for
emote_typefield in response. - Removed
broadcaster_idquery parameter.
- Expanded possible values for
### 2024‑03‑15
This release includes the following updates:
- 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.
-
- Moderator Actions
- 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.
-
- Unban Requests
- Twitch API
### 2024‑03‑07
This release includes the following updates:
-
Channel Chat Settings Update has moved from public beta to v1. - 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.
-
- Unban Requests
- Twitch API:
### 2024‑02‑01
The following releases and changes have been made:
- The Twitch Game Engine Plugins are now generally available for building integrations in Unity, Unreal, and other C++ engines.
- Get Moderated Channels has moved from public beta to v1.
- 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_idhost_user_namehost_user_login
- Updated definitions for all
broadcaster_*fields to reference the non-hosting streamer in a channel:
broadcaster_user_idbroadcaster_user_namebroadcaster_user_login
- Added three new fields:
-
- Conditions
-
Channel Guest Star Session End Condition and Channel Guest Star Session Update Condition:
- Updated the definition for
broadcaster_user_idto refer to the non-hosting broadcaster of the channel.
- Updated the definition for
-
### 2024‑01‑25
This release includes the following updates:
- 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.
-
- Twitch API:
- 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.
-
- Added a new Twitch API endpoint:
### 2024‑01‑08
This release includes the following updates:
-
Get Moderated Channels and channel.chat_settings.update have been added to open beta. -
user:read:moderated_channelshas been added to the Twitch API scopes.
### 2023‑12‑11
The following Ads Manager endpoints and subscription type have been moved from open beta to generally available with the following changes, where applicable:
-
Get Ad Schedule
-
length_secondshas been renamed toduration. -
preroll_free_time_secondshas been renamed topreroll_free_time.
-
- Snooze Next Ad
-
channel.ad_break.begin
-
length_secondshas been renamed toduration_seconds.
-
### 2023‑12‑05
Device Code Flow (DCF) is now generally available.
Refer to Authentication Overview and Device code grant flow for more information.
### 2023‑11‑15
The following EventSub subscription types have been moved from open beta to generally available:
- channel.chat.clear
- channel.chat.clear_user_messages
- channel.chat.message_delete
-
channel.chat.notification
- Additionally, removed
sub.cumulative_monthsfrom the event payload
- Additionally, removed
### 2023‑11‑07
Made the following changes to the channel.chat.notification EventSub subscription type in open beta:
- All instances of
sub_planhave been renamed tosub_tier. - For the
subandresubevents, thePrimevalue has been removed fromsub_tier. - For the
subandresubevents, a newis_primefield has been added to indicate if the subscription was purchased through Prime. Prime subs will only have asub_tiervalue of1000. - A new
badgesfield has been added, which returns a list of chat badges.
### 2023‑10‑19
Added the following Twitch API endpoints and EventSub subscription types to open beta:
- Chat on Eventsub
-
channel.chat.clear - sends a notification when a moderator or bot clears all messages from the chat room. -
channel.chat.clear_user_messages - sends a notification when a moderator or bot clears all messages for a specific user. -
channel.chat.message_delete - sends a notification when a moderator removes a specific message. -
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
-
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. -
Snooze Next Ad - Pushes back the timestamp of the upcoming automatic mid-roll ad by 5 minutes. -
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:
-
channel:bot- Allows the client’s bot users access to a channel. -
user:bot- Allows client’s bot to act as this user. -
user:read:chat- View live stream chat and room messages. -
channel:manage:ads- Manage ads schedule on a channel. -
channel:read:ads- Read the ads schedule and details on your channel.
### 2023‑10‑18
The Twitch Drops guide has been updated for the latest version as announced on Improving the Flexibility of Twitch Drops.
### 2023‑09‑12
This release includes the following updates to the Get Clips API endpoint:
- The optional
is_featuredfield has been added to the request parameters to allow returning only featured clips, non-featured clips, or both if the parameter is not present. - The
is_featuredfield has been added to the response body, indicating if the clip is featured or not.
### 2023‑09‑06
This release includes the following updates, detailed in the Legacy Follows API and Eventsub Shutdown Timeline post here:
- The Get Users Follows API endpoint has been removed.
-
Get Channel Followers now requires the user access token to contain both the moderator:read:followers scope and have either the user ID match thebroadcaster_idor 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 theuser_idparameter. - V1 of channel.follow has been removed.
### 2023‑08‑24
This release includes the following updates:
- The Channel Guest Star Guest Update notification now sends when a slot is updated, and includes information about the slot, if applicable.
- The Guest Star Slot Update event has been removed, as its information is now included in the Channel Guest Star Guest Update event.
- The
moderator:read:guest_starandmoderator:manage:guest_starscopes have been added to the following subscription types:
### 2023‑08‑04
This release includes the following updates:
-
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
-
Guest Star Guest Update now includes theacceptedstate for when a guest has accepted their invitation to the Guest Star session.
### 2023‑07‑19
IRC Tags for PRIVMSG have been updated to include Hype Chat.
Video Broadcast updated to refer to the latest broadcasting guidelines.
### 2023‑07‑17
This release includes the following updates:
- Moved Version 2 of channel.update from open beta to generally available.
- The following Twitch API endpoints have been decommissioned and removed from documentation:
- “Get Soundtrack Current Track”
- “Get Soundtrack Playlist”
- “Get Soundtrack Playlists”
- Increased the maximum number of enabled subscriptions per WebSocket connection from 100 to 300.
### 2023‑07‑10
This release includes the following updates related to content classification labels and branded content:
- 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.
- 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.
- Added the Twitch API endpoint Get Content Classification Labels, which shows you the available content classification labels.
### 2023‑06‑29
Moved the following changes to existing subscription type channel.update to open beta:
- Removed the
is_matureboolean flag - Added a new
content_classification_labelsfield that lists the IDs of any content classification labels applied on the channel
### 2023‑06‑15
Authorization Revoked has been added for PubSub.
### 2023‑05‑22
This release includes the following updates:
- Made the following changes to Get Channel Guest Star Settings:
- The following authentication scopes have been added
moderator:read:guest_starmoderator:manage:guest_star
- A
moderator_idis now required in the request query parameters
- The following authentication scopes have been added
- Removed the Twitch API v5 Migration Guide
### 2023‑05‑11
Added the following Twitch API endpoints and subscription types to open beta:
-
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_starchannel:manage:guest_starmoderator:read:guest_starmoderator:manage:guest_star
### 2023‑04‑12
The EventSub WebSockets connection URL has been updated to wss://eventsub.wss.twitch.tv/ws. See the announcement for more details.
### 2023‑04‑05
Twitch’s CLI has been updated to allow for testing Reconnect message flow and forwarding EventSub events to the mock WebSocket server.
### 2023‑03‑30
Get Channel Chat Badges and Get Global Chat Badges have been updated to include the following return fields; title, description, click_action, and click_url. See the announcement for more information.
### 2023‑03‑15
References to the Twitch Developer Rig have been updated or removed following the end of support announcement.
### 2023‑02‑28
This release includes the following updates:
-
Search Channels, Get Streams, Get Followed Streams — Include the following changes:
- Added customizable tags via a new
tagsfield. - Deprecated the
tag_idsfield in the response. The response continues to include the field; however, it will only return an empty array.
- Added customizable tags via a new
-
Get All Stream Tags and Get Stream Tags — Include the following change:
- Deprecated the
tag_idsfield 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
- Deprecated the
- Additionally, removed the Replace Stream Tags endpoint.
For information about these changes, see Adding customizable tags to the Twitch API.
### 2023‑02‑27
“Get Code Status” and “Redeem Code” Twitch API endpoints have been decommissioned and removed from documentation.
### 2023‑02‑22
This release includes the following updates:
- 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 themoderator:read:followersscope.
-
- Added deprecation notices to the following:
- Updated the Product Lifecycle with the above deprecation notice.
### 2023‑02‑09
Moved the following Shoutout endpoint and subscription types from open beta to generally available:
-
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.
### 2023‑02‑03
Added the following Twitch API endpoints and subscription types to open beta.
-
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 themoderator:read:followersscope.
low-trust-users has been added to PubSub reference.
### 2023‑01‑19
This release includes the following updates:
- 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.
-
- 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.
-
### 2023‑01‑10
This release includes the following updates:
- 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.
-
- Added the
tagsfield to the following endpoints:
The
tagsfield contains the tags that the broadcaster or Twitch added to help identify the content that the broadcaster streams.
- Added the
tagsfield 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. - Added the
idfield to the Get Charity Campaign Donations response to identify the donation. - Added the
idfield to the Charity Donation event data to identify the donation.
### 2022‑12‑09
This release includes the following updates:
- Added the following missing status values that Get EventSub Subscriptions may return in the
statusfield. 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.
-
### 2022‑12‑05
This release updates Twitch’s CLI with the following changes:
- 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.
-
- 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.
-
- Changed the
user.updateevent name in the documentation touser-updateto match the convention used by the other events.
### 2022‑12‑02
This release includes the following updates to the Twitch endpoints:
- 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.
- Added the Get Shield Mode Status endpoint, which gets the broadcaster’s Shield Mode activation status.
- Updated the status of the Get Chatters endpoint from Beta to generally available.
This release includes the following updates to the EventSub subscription types:
- Added the channel.shield_mode.begin subscription type, which sends a notification when the broadcaster activates Shield Mode.
- Added the channel.shield_mode.end subscription type, which sends a notification when the broadcaster deactivates Shield Mode.
### 2022‑11‑29
Updated the Get Channel Information endpoint to require a user access token to return the Partner’s stream delay value (see the delay field). By default, the delay field’s value is zero.
### 2022‑11‑22
Updated the channel.charity_campaign.stop subscription type to include the following fields:
charity_namecharity_descriptioncharity_logocharity_website
Updated the channel.charity_campaign.donate and
channel.charity_campaign.progress subscription types to include the following fields:
charity_descriptioncharity_website
### 2022‑11‑21
Added the IGDB ID to the Get Games and Get Top Games responses (see the igdb_id field).
Updated the Get Games endpoint to let you search by IGDB ID.
### 2022‑11‑17
Added the user_id and user_name fields to the Get Chatters response.
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_removedas a possible status value to EventSub. The subscription’sstatusfield is set toversion_removedif EventSub stops supporting the subscribed to subscription type and version. EventSub sends the status in a revocation message.
### 2022‑11‑04
This release includes the following updates:
-
Updated the CLI’s Generating Mock Data and Starting the Server topic to remove the erroneous
user_idparameter from the table under Getting an app access token.
-
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
typefield under thelast_contributionandtop_contributionsfields.
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
typefield under thelast_contributionandtop_contributionsfields.
- OTHER — Covers contribution methods other than Bits and Subscriptions. See the
-
Added the Broadcast Scheduling Guide.
### 2022‑11‑02
Updated the channel.charity_campaign.donate subscription type to include the following fields in the event’s data:
-
charity_name— The charity’s name. -
charity_logo— A URL to the charity’s logo.
### 2022‑11‑01
Added WebSocket support for EventSub notifications. See Handling WebSocket Events.
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
methodfield. - Require the
callbackfield only if themethodfield is set to webhook. - Require the
secretfield only if themethodfield is set to webhook. - Add the
session_idfield, which identifies the WebSocket to send notifications to. This field is required only if themethodfield is set to websocket. - Added the
connected_atfield, 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 themethodfield is set to websocket. - Added the
disconnected_atfield, 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 themethodfield is set to websocket.
### 2022‑09‑29
Added the Get Chatters endpoint, which you use to get the list of users that are connected to the specified broadcaster’s chat session.
### 2022‑09‑16
Breaking change to the Beta channel.charity_campaign.donate EventSub subscription type:
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.
### 2022‑09‑01
Updated the Create Poll endpoint to remove support for voting with Bits. This change removes the following optional request fields from the documentation:
bits_voting_enabledbits_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:
### 2022‑08‑26
Added the vip tag to PRIVMSG. You can use the tag to determine whether the user that sent the chat is a VIP.
### 2022‑08‑25
Adds the following API and subscription type that you can use to get information about the charity campaign that the broadcaster is running.
-
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.
### 2022‑08‑12
Added the Moderation Guide that shows how to use the moderation APIs such as adding and removing moderators, banning users or putting them in a timeout, and updating your AutoMod settings.
### 2022‑07‑29
All Twitch API endpoints introduced on 2022-07-15 have moved from public beta to general availability.
### 2022‑07‑22
Added the following guides:
-
Creating Clips — Shows how to create and get clips. -
Creating Markers — Shows how to create and get stream markers.
### 2022‑07‑20
Added the vod_offset field to the Get Clips API response. The offset is the number of seconds from the start of the video to the beginning of the clip.
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).
### 2022‑07‑15
This release adds the following endpoints. See :
-
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:announcementsmoderator:manage:chat_messagesuser:manage:chat_colorchannel:manage:moderatorschannel:read:vipschannel:manage:vipsuser:manage:whispers
### 2022‑07‑11
Submission Best Practices - Updated the “Content in Extensions” section to define the expected functionality of global overlay Extensions and examples.
### 2022‑06‑29
Twitch API - Organization and content for this section has been improved for a better developer experience.
Twitch Drops - Japanese localization added.
### 2022‑06‑27
Check AutoMod Status — Includes the following changes:
- Deprecated and removed the
user_idfield 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_countfield 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:
descriptionidimage_urltitle-
tracks(thedatafield 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.
### 2022‑06‑08
Added the ability for your application to start or cancel a raid. Read more
This update adds the following endpoints:
Added the created_at field to the response object of the following endpoints:
### 2022‑06‑02
Create Prediction - Updated to allow specifying up to ten outcomes.
### 2022‑05‑17
Added fields to the following EventSub subscription types:
-
user.update — Added theemail_verifiedfield, which indicates whether Twitch has verified the user’s email. -
channel.ban — Added thebanned_atfield, which indicates the UTC date and time of when the user was banned or put in a timeout. -
channel.hype_train.begin — Added thelevelfield, which indicates the level at which the Hype Train started.
Extension Guidelines and Policies - Added section 4.11 regarding NFTs in Twitch Extensions.
### 2022‑05‑09
Extension Submission Best Practices
- 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
### 2022‑04‑29
Chat & Chatbots - Organization and content for this section has been improved for a better developer experience.
### 2022‑04‑13
Added 409 Conflict as a possible response code to Ban User and Unban User.
Added information about when the Twitch API may introduce breaking and non-breaking changes to the API. For details, see Breaking Changes.
### 2022‑04‑12
Enhanced Experiences and Event-based Drops have been decommissioned and documentation has been removed.
### 2022‑04‑07
Authentication - Organization and writing for this section has been improved for a better developer experience.
Get Hype Train Events - Removed id query parameter. See the deprecation announcement for more information.
### 2022‑03‑18
Removed documentation for “Get Banned Events” and “Get Moderator Events” Twitch API endpoints. For more information about the deprecation and removal of these endpoints, see the deprecation announcement.
### 2022‑02‑28
Twitch API v5 endpoints (i.e. kraken) are no longer available. Documentation for these endpoints have been removed.
### 2022‑02‑25
Chat msg-id tags updated for accuracy.
### 2022‑02‑11
Updated the Chatbots content with the following changes:
-
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.