Documentation Changelog

Added Increasing Feedback in Extensions.

Removed communities-related data fields from Get Streams and Get Streams Metadata endpoints. These fields are no longer supported.

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.

Corrected msg_id parameter type in Check AutoMod Status from integer to string.

Added an updated Glossary.

Edited the payload example in Topic: Subscription Events.

Edited optional Create Stream Marker parameter description to include a max length of 140 characters.

Removed “Increasing Feedback in Extensions”.

Update Mobile Deep Links

Updated Organizations (formerly “Companies”).

Updated Extensions: Developer Rig

Updated Extensions: Increasing Feedback in Your Extension.

Add RBAC info to “Companies” (now “Organizations”)

Added 2.10 and 2.11 to Extensions Guidelines and Policies.

Updates to “Extensions: Designing” guide.

Add RBAC information to Extensions Life Cycle Management and Monetization. 

Corrected URL for endpoint Get Moderator Events.

Extensions update - reset file ordering

Retry adding 3 new Extensions docs (A/B Testing, Google Analytics, & Increasing Feedback)

DA-430: Add three new Extensions documents: Using A/B Testing in Extensions, Using Google Analytics in Extensions, and Increasing Feedback in Extensions. Also made minor change in Drops (meaning of “retries”).

Updated “Chatbots & IRC” docs (Getting Started, Guide, Membership, Commands, Tags, & Chat Rooms), except for “msg-ID Tags”.

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

Added documentation for Get Subscription Events endpoint.

Added documentation for Subscription Events webhook.

Documented the new Moderation API.

Documented two new webhooks:

• Moderator Change Events
• Channel Ban Change Events

Insights & Analytics updates (twice today)

Changed “position” to “policies” in Extensions: Guidelines and Policies, section 6.6.

Added clarification to the Get Users endpoint in the Twitch API Reference that the limit of 100 IDs and login names is a total limit, not 100 of each.

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.

Extensions Life Cycle Management: Added section on Control Security Policy (CSP)

Removed deprecated Channel Feed API Reference.

Extensions Guidelines & Policies:

• Added policy 6.2.8.

Added Get Extension Transactions to the Twitch API Reference.

Added Extension Transaction Created to the Webhooks Reference.

Updated v5 API Guide: New third-party development will be limited to the API versions Kraken v5 and Helix. Limitation of new development will be enforced on client ID created on or after 5/31/2019.

Removed orphan Bits Code Redemption Guide and added the content to the API Reference.

Fixed date errors in the changelog.

Fixed code formatting errors in several endpoints.

Updated Configuration Service documentation.

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

Removed note that Webhooks parameters must appear in alphabetical order because that restriction no longer exists.

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 whitelist).
• Previous 5.2 and 5.3 reworked and appended to mention the commerce beta program.

Updated link to download the Developer Rig for Windows.

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

Deleted Communities Reference from v5 API because it is deprecated.

Video: Updated Video Upload Guide and Video Reference to note that you must be a Partner or Affiliate to upload VODs.

Chatbots & IRC: Twitch Tags: Added note that undocumented tags can be added/removed at any time. Also, tags may appear in any order. So, developers should write code to parse tags individually and ignore unrecognized tags.

Chatbots & IRC: Twitch Tags: Added new badge-info parameter to GLOBALUSERSTATE, PRIVMSG, USERNOTICE, and USERSTATE.

Getting Started with Extensions and Extensions Developer Rig: Changes based on the new Developer Rig UI. Updated “Hello World” example in Getting Started.

Extensions Reference: Added information related to Monetization.

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.

Websub: Updated documentation to make it clear that the order of query parameters matters.

Bits: Small edits to documentation, for clarity.

Chatbots & IRC: Twitch Tags: Added several more msg-param parameters (for USERNOTICE).

Chatbots & IRC: Twitch Tags: Deleted broadcaster-lang (from ROOMSTATE). Added several more valid values for the msg-id field (for USERNOTICE).

Extensions doc set: Many changes. New version of Getting Started with Extensions. New Extensions manager UI (see Extensions Life Cycle Management).

Insights & Analytics: Added mod author analytics.

PubSub: Added topic channel-bits-events-v2. Removed deprecated months field. Added new cumulative-months and streak-months fields.

Chatbots & IRC: Twitch Tags: For USERNOTICE, added three fields (msg-param-cumulative-months, msg-param-should-share-streak, msg-param-streak-months) and changed when msg-param-months is sent.

Apps & Authentication: Added the scope channel:read:subscriptions.

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

Apps & Authentication: Clarified language around deprecation of Twitch API v. 5.

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

Extensions Reference: Added locale parameter to “Client Query Parameters.”

Extensions Developer Rig: Added section on “Enabling 2FA.”

New Twitch API Reference: Added new endpoints: Replace Stream Tags, Get Stream Tags, and Get All Stream Tags. Updated Get Streams endpoint to document new tags functionality.

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.”

Getting Started with Chatbots & IRC: New version of this doc.

Extensions Guidelines & Policies: New version of this doc.

Code Redemption API: New reference document.

Extensions Reference: Moved Bits-related reference information (JS helper functions) here, to consolidate all Extensions reference info in one place. The Bits in Extensions document is now purely a guide.

Company Management: New document on registering companies and managing users in them. Company registration is required before you can manage games on Twitch or create Drops campaigns.

Getting Started with Extensions, Extensions Developer Rig: Deleted information about the Developer Rig “local mode” (no longer available).

Apps & Authentication: Getting Tokens: OIDC: Added claims and UserInfo endpoint.

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.

Twitch IRC Capability: msd-ID Tags: This new document (under Chatbots & IRC) contains a complete (lengthy) list of all msg-id tags that apply to the NOTICE (Twitch Commands) and NOTICE (Twitch Chat Rooms) commands.

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.

Extensions Guidelines & Policies: New version of this document.

New Twitch API Reference, New Twitch API: Webhooks Reference: Added a display-name response field to several endpoints and webhooks. Endpoints affected: Get Bits Leaderboard, Get Clips, Get Streams, Get Streams Metadata, Get Stream Markers, Get Users Follows, Get Videos. Webhooks affected: Stream Changed, User Follows.

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

Apps & Authentication Guide: In “Types of Tokens,” added a clarification about bearer tokens.

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

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

Extensions: Onboarding is now required only for monetization (Bits).

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

Extensions: Added the new Configuration Service. See:

• 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.

Chatbots & IRC: Twitch Commands, Chatbots & IRC: Twitch Tags: Added CLEARMSG, single-message removal on a channel.

Drops Guide: Added recommendations for campaigns.

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

Drops Guide: New functionality for creating and using items, with a new Item Manager page and new fields for items. See especially the section on using campaigns.

Extensions Developer Rig: New document focusing on the rig. Also see changes to the Developer Rig section of Getting Started with Extensions.

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).

New Twitch API: Webhooks Guide: There are changes to subscription limits. Each client ID can have at most 10,000 subscriptions. Also, you can subscribe to the same topic at most 3 times.

New Twitch API Reference: New optional query string parameters (started_at and ended_at) for Get Clips.

Extensions Reference: New JS helper function, minimize. See Helper: Actions

New Twitch API Reference: Added new endpoints, Create Stream Marker and Get Stream Markers.

Insights & Analytics: Added three new clips fields to game-developer analytics.

Getting Started with the New Twitch API: When registering your app, the app name must not include “Twitch” (as an exact or fuzzy match), or registration will fail.

Extensions (several docs): Added pop-out Extensions. Start reading here in Required Technical Background (this links to relevant info elsewhere in the doc set).

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

Insights & Analytics: Added Twitch Quarterly Insights (fact sheet for games).

Building Extensions: Due to requirements recently communicated to us by Apple, Extensions support on iOS devices (including the ability to test on iOS) is now restricted to Apple Developer Program members. See “Mobile Support.”

• 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.

Insights & Analytics: Added V2 of extension analytics.

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

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

Chatbots & IRC: Twitch Tags: Marked some parameters as deprecated (subscriber, turbo, and user_type). Use the badges parameter instead.

New Twitch API Reference: Added Get Webhook Subscriptions endpoint.

Designing Extensions: Added more guidance for all extensions and panel extensions.

Apps & Authentication: Guide, Getting Tokens: OAuth, & Getting Tokens: OIDC: Added token_type parameter (required value = bearer) in several places.

Bits in Extensions: New document.

Extensions Guidelines & Policies: Added Bits in Extensions requirements.

Twitch API v5 Channel Feed Reference: Changed (deprecated) most endpoint responses.

Getting Started with Extensions, Building Extensions: Added information about the Twitch Developer Rig “local mode” (for local testing against mock, non-production endpoints).

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.

Insights & Analytics: Added V2 of game analytics.

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.”

Extensions Reference: Expanded the definition of onPositionChanged JS helper function.

Building Extensions: In “Local Test,” added information about the new Invite Only tab, for seeing whitelisted 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.

Embedding Video & Clips: In setVideo, added a new Timestamp parameter.

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

Having Extensions Reviewed: Before you submit an extension for review, you now select a category under which your extension will be shown in the Extension Manager and upload an image for “discovery” purposes. 3/7/19 update: This document was deleted; information is in Extensions Life Cycle Management.

Getting Started docs:

• 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.)

Embedding Twitch and Chatbots & IRC: These large documents were spit into several smaller docs, to make it easier to read and find information.

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

Getting Started with Extensions: In “Procedure for Non-Twitch Partners/Affiliates,” the last step of beginning the onboarding process was changed.

New Twitch API Reference:

• 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).
• In Get Streams Metadata, an optional query string parameter was deleted, type. This was not working properly; only live streams are supported. All current integrations will continue to function:
  • If type is not specified or it is specified to be all or live, the results will contain only live streams.
  • If type is specified to be vodcast, the results will be an empty array.

Extensions: The Extensions Guide was split into several shorter docs. Look in the Extensions doc category.

Embedding Video and Clips: In “Interactive Frames for Live Streams and VODs” > “Optional Parameter,” the default of the parameter playsinline parameter was changed to true.

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).

Embedding Video and Clips: In “Events Emitted by and Defined by the Player,” a new  Twitch.Player.PLAYBACK_BLOCKED event was added.

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).

Apps & Authentication Guide: See new wording in “Validating Requests.”

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.