Contents

Documentation Release Notes

Date Documentation Changes
7/20/18

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

7/19/18

Added a new Extensions document, Bits in Extensions Guide & Reference.

Added Bits in Extensions requirements.

7/12/18 Twitch API v5 Channel Feed Reference: Changed (deprecated) most endpoint responses.
7/6/18

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.
6/22/18

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

6/19/18

Extensions Reference: In “JavaScript Helper,” expanded the definition of onPositionChanged.

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.
6/7/18

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

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

6/4/18

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.

5/31/18

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 Reference: Added pagination parameters and additional example to Get Game Analytics. Added Get Extension Analytics endpoint.

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.)
5/21/18

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

In the Extensions Reference, the onVisibilityChanged JS helper function now works with component extensions.

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

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.
5/2/18 The Extensions Guide was split into several, shorter docs. Look in the Extensions doc category.
4/19/18

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). 5/2 update: Now that the Extensions Guide has been split up, this information is in Required Technical Background for Extensions.

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).
4/4/18

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).
3/29/18

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