Contents

Documentation Changelog

Date Documentation Changes
10/26/2020

API Reference:

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

 

10/09/2020

Updates to the API Reference:

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

09/23/2020

Removed links to internal documents in Increase Feedback in Extensions.

09/17/2020

Added to the v5 API Get Channel Subscribers endpoint the information that if a user in the subscribers list has been banned, the subscription information will be provided, but the user object will have a value of null.

09/15/2020

Edited all documentation to replace the terms “blacklist” and “whitelist” with “denylist” and “allowlist”.

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.

09/14/2020

Updated the following endpoints to make clear they are about Bits codes:

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

09/12/2020

Added discussion of subscription status support to the Extensions Monetization documentation.

Clarified language in the Create Clip endpoint documentation.

09/07/2020

Documented authentication and Join rate limits for chat.

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

 

 

08/28/2020

Removed mention of a webhook for Drops because it is not yet available.

08/25/2020

Updated the API Reference to note that the clips service returns a maximum of 1000 clips.

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.

08/21/2020

Fixed code sample for Events-based Drops.

08/20/2020

Updated Authorization section for the Get Clips endpoint to indicate that a user access token is required.

08/18/2020
08/13/2020

Added a new section to our Extension Submission Best Practices: Template for a helpful Walkthrough Guide and Change Log

07/30/2020

Updated Marketing and Developer User Roles.

07/30/2020

Updated Webhooks documentation to describe notification timeout.

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

07/23/2020

Updated Extensions documentation to reflect new process for required review channels.

07/21/2020

Addressed issues in the API reference for the following endpoints:

07/06/2020

Added required authorization for the Get Streams endpoint and updated sample code.

07/01/2020

Added new fields to the Channel Subscriptions Event Pubsub topic and a new USERNOTICE tag parameter in support of Multi-Month Subscription Gifting.

06/22/2020

Updated the Authentication Guide to mention that developers can provide multiple redirect URIs.

06/22/2020

Bug fixes in the API Reference.

06/18/2020

Added new endpoints to the API Reference and Webhooks Reference:

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

06/15/2020

Added links to rate limits documentation to the API Reference.

06/03/2020

Clarified the definition of Subscription denied in the Webhooks Guide.

05/12/2020

Removed documentation of MODE and NAMES in the IRC documentation because they have not functioned correctly for some time and will not be supported.

05/08/2020

Drops Guide: Updated Create Entitlement Grants Upload URL example to include Client ID.

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

05/04/2020

Fixed a bug in the API Reference. The optional scope for the Get Users endpoint should be user:read:email.

05/01/2020

Updated the Twitch API Reference to reflect that OAuth is now mandated.

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.

04/27/2020

Updated Extensions Best Practices: 

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

04/20/2020

Updated Drops documentation to align with UI changes.

04/01/2020

Deleted documentation of these deprecated v5 endpoints: 

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

Corrected URL for Get Extension Transaction endpoint.

03/30/2020

Updated definition of “language” in v5 Streams API Reference.

03/27/2020

Published new Extensions Guide.

03/18/2020

Updates to the Embedding Twitch documentation: 

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

Updated the Extensions Guidelines & Policies to add Moderation.

02/25/2020

Edited the following endpoints in the v. 5 API Reference:

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.

02/14/2020

Updated the game_id parameter in the Get Streams endpoint from up to 100 IDs to up to 10 IDs.

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.

02/13/2020
  • Removed the live query string parameter from the Search Games endpoint documentation.
  • Removed the popularity response field from the Search Games and the Get Top Games endpoint documentation.
01/24/2020

Updates to PubSub documentation

  • 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
01/10/2020
  • Updated documentation to reflect that OAuth is the preferred method of authentication.
  • Removed documentation for chat rooms because the feature is deprecated.
01/08/2020

Extensions tutorials are now live on the site.

12/17/2019

Webhooks Reference

  • 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.
12/16/2019

Added the Channel Points PubSub topic.

12/05/2019

Added chat rooms to the Product Lifecycle page as deprecated.

12/02/2019

Updated the Getting Tokens OIDC doc to note that the email and email_verified claims will soon be gated by user:read:email scope.

10/22/2019

Updated review section in Extensions Life Cycle Management doc to include review SLA.

10/16/2019

Added Product Lifecycle page to the site.

09/28/2019

Added links to the Developer Rig in these pages: 

09/11/2019

Added Increasing Feedback in Extensions.

09/10/2019

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.

09/06/2019

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

09/04/2019

Added an updated Glossary.

08/22/2019

Edited the payload example in Topic: Subscription Events.

08/14/2019

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

Removed “Increasing Feedback in Extensions”.

08/07/2019

Update Mobile Deep Links

08/05/2019

Updated Organizations (formerly “Companies”).

Updated Extensions: Developer Rig

Updated Extensions: Increasing Feedback in Your Extension.

08/04/2019

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

07/31/2019

Added 2.10 and 2.11 to Extensions Guidelines and Policies.

Updates to “Extensions: Designing” guide.

07/30/2019

Add RBAC information to Extensions Life Cycle Management and Monetization. 

07/29/2019

Corrected URL for endpoint Get Moderator Events.

07/22/2019

Extensions update - reset file ordering

07/19/2019

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

07/18/2019

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

07/09/2019

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

06/27/2019

Added documentation for Get Subscription Events endpoint.

Added documentation for Subscription Events webhook.

06/25/2019

Documented the new Moderation API.

Documented two new webhooks:

06/21/2019

Insights & Analytics updates (twice today)

06/20/2019

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

06/19/2019

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.
06/13/2019

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

06/07/2019

Removed deprecated Channel Feed API Reference.

06/06/2019

Extensions Guidelines & Policies:

  • Added policy 6.2.8.
06/04/2019

Added Get Extension Transactions to the Twitch API Reference.

Added Extension Transaction Created to the Webhooks Reference.

05/30/2019

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.

05/08/2019

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

Fixed date errors in the changelog.

05/07/2019

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.

04/19/2019

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 allowlist).
  • Previous 5.2 and 5.3 reworked and appended to mention the commerce beta program.
04/18/2019

Updated link to download the Developer Rig for Windows.

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

04/16/2019

Deleted Communities Reference from v5 API because it is deprecated.

04/15/2019

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

03/27/2019

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.

03/26/2019

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

03/18/2019

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

03/15/2019

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.

03/14/2019

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

Bits: Small edits to documentation, for clarity.

03/11/2019

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

03/08/2019

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

03/07/2019

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

02/21/2019

Insights & Analytics: Added mod author analytics.

02/08/2019

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

02/04/2019

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.

01/30/2019

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

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

01/28/2019

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

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

01/22/2019

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

01/18/2019

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

01/17/2019

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

12/21/2018

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

12/19/2018

Extensions Guidelines & Policies: New version of this doc.

12/17/2018

Code Redemption API: New reference document.

11/30/2018

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.

11/28/2018

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.

11/27/2018

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

11/14/2018

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.

11/02/2018

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.

10/24/2018

Extensions Guidelines & Policies: New version of this document.

10/23/2018

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.

10/22/2018

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.

10/16/2018

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

10/10/2018

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.

10/09/2018

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

10/02/2018

Drops Guide: Added recommendations for campaigns.

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

10/01/2018

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.

09/28/2018

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

09/14/2018

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.

09/11/2018

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

09/07/2018

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

09/06/2018

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

09/04/2018

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

09/03/2018

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.

08/30/2018

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

08/21/2018

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

08/13/2018

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.

08/07/2018

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.

08/02/2018

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

07/31/2018

New Twitch API Reference: Added Get Webhook Subscriptions endpoint.

07/27/2018

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

07/20/2018

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

07/19/2018

Bits in Extensions: New document.

Extensions Guidelines & Policies: Added Bits in Extensions requirements.

07/12/2018

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

07/06/2018

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.

06/22/2018

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

06/19/2018

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

06/07/2018

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

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

06/04/2018

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.

05/31/2018

Getting Started docs:

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

05/21/2018

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.

05/15/2018

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

05/09/2018

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.
05/02/2018

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

04/29/2018

Updated Organizations documentation. 

04/19/2018

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

04/04/2018

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

03/29/2018

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.