81 results found

1. Disambiguate the "Legacy" API in documentation

   This page should mention that "v5" and the "kraken" api refer to the same thing. Me and my friends always used "Kraken" to refer to this api, it's in the endpoint its self.

   I'm sure we are not alone in this, please mention that v5 IS the Kraken endpoint, you should even rename the side-section to say "Legacy Twitch API v5 (Kraken)"

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

2. Please revert the EventSub documentation format changes

   You changed the EventSub documentation between last night (Nov 16, 2021) and today (Nov 17, 2021). The new documentation is very confusing. Specifically speaking:

   • The Subscription Types documentation links on the left side are out of order and like-kind events are not next to each other. For example, "Redemption Status Update" should be next to "Channel Points redeem reward".
   • The Subscription Types are poor named, and it's a little difficult to figure out which Subscription Type goes to which event.
   • The URL to go straight to the section in the Subscription Types is different from the type supplied in an EventSub call. It makes it harder to know I'm going to the right documentation without clicking on the Subscription Type link and reading part of the documentation after I've been redirected to the documentation. For an explicit example, let's say I'm looking for Channel Points Reward Redemption Update documentation (channel.channelpointscustomrewardredemption.update). I first look through the list of Subscription Types and see four "Channel Points" related events, but Channel Points reward redemption update is not there. Instead, it's named "Reward status update" and much further down the list. When I see just 4 of the expected 5 EventSub types on first glance, my initial thought is you've removed an EventSub event type. Upon further inspection, I realized it was just named poorly.
   • The old documentation had an EXTREMELY helpful table at the top of the documentation that described the "Category" of EventSub types, "Type" for the specific EventSub event, and a brief note about what that event was notifying about. This table is gone, and now I'm having to click on -EVERY- -SINGLE- -ONE- of the event types in order to figure out what each of those events are for.
   • You got rid of the example CURL calls for each of the Subscription Types, which, at a glance, let me know EXACTLY what needed to be included in a request for that specific Subscription Type.
   • You got rid of the example payloads for each of the Subscription Type calls, so now I' have to use no less than THREE different documentation pages to make sure I'm constructing the right payload for each event.
   • The old documentation had a table for the Condition parameters for each Subscription Type. The old table was INCREDIBLY helpful because it let me know in an well-formatted way exactly what parameters were mandatory, which were optional, and which conflicted with each other. This paragraph description is basically USELESS and makes it much harder to figure out what I need to do on my end from a programming standpoint.
   • The Example Event Data does not include a full response from a successful call, so, once again, I have to go to THREE OR MORE documentation pages to figure out what a response call might look like. Even then I'm not entirely sure it's correct, so I'm left making calls to create EventSub notifications to see if I'm parsing everything correctly. The lack of a FULL response is slowing down my testing and validation that I'm doing things correctly on my end.

   I'm done for now, but I'm sure I'll find more stuff that's terrible about this new documentation format.

   You changed the EventSub documentation between last night (Nov 16, 2021) and today (Nov 17, 2021). The new documentation is very confusing. Specifically speaking:

   • The Subscription Types documentation links on the left side are out of order and like-kind events are not next to each other. For example, "Redemption Status Update" should be next to "Channel Points redeem reward".
   • The Subscription Types are poor named, and it's a little difficult to figure out which Subscription Type goes to which event.
   • The URL to go straight to the section in the Subscription Types is different from the type supplied in an… more
   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  2 comments  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

3. dimensionn

   There's a typo under mobile guidelines:
   "dimensionn"

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

4. missing scopes

   Scope list says it's comprehensive, but it does not include user:read:email which is listed in some other docs.

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

5. Fix or improve your API Documentation.

   Step 2 is unclear or wrong.

   I'm unable to make it work only by changing the Client-ID, nor removing the Authentication headers.
   You should precise that both need to be changed. Or maybe the OAuth token should work, but it doesn't.

   Fix your documentation it's important for developers that everything written here is clear and easily understandable by anyone (or at least devs).

   I recommend you to make a full review of the entire documentation... (Get some newbie devs to test it, if they do not understand, it's not written correctly)

   Also I really encourage you to make some sample code (like google does) publishing them on a git repo or anything like this.

   And maybe you can make some Client Libraries (like Google does, again).

   Step 2 is unclear or wrong.

   I'm unable to make it work only by changing the Client-ID, nor removing the Authentication headers.
   You should precise that both need to be changed. Or maybe the OAuth token should work, but it doesn't.

   Fix your documentation it's important for developers that everything written here is clear and easily understandable by anyone (or at least devs).

   I recommend you to make a full review of the entire documentation... (Get some newbie devs to test it, if they do not understand, it's not written correctly)

   Also I really encourage you to make some sample… more

   5 votes

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   1 comment  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close
   Completed  ·  AdminJon Bulava (Developer Advocate Lead, Twitch) responded

   Earlier in the year, the API example had been fixed and the guide has been rewritten.

6. broken link

   the register your app link is broken
   it's https://dev.twitch.tv/dashboard/apps/create
   but should be
   https://dev.twitch.tv/console/apps/create

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  0 comments  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

7. possible grammatical change

   on page https://dev.twitch.tv/docs/pubsub
   "These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a PubSub connection to receive updates to this state. The updates act as “diffs” to the initial state."
   Unsure it's stated correctly as PubSub is the model but not the connection. The connection protocol is WebSocket. Should possibly read:
   "These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a WebSocket connection to receive updates to this state. The updates act as “diffs” to the initial state."

   on page https://dev.twitch.tv/docs/pubsub
   "These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a PubSub connection to receive updates to this state. The updates act as “diffs” to the initial state."
   Unsure it's stated correctly as PubSub is the model but not the connection. The connection protocol is WebSocket. Should possibly read:
   "These example applications share a common pattern: on application load, the application fetches a complete snapshot of its state and uses a WebSocket connection to receive updates to this state. The updates act as “diffs” to the… more

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  2 comments  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

8. Link Scope API with capabilities

   Hello Twitch !
   Can you please add links to api capabilities on each scope ? It would be very useful :-)

   Best regards
   LMD

   1 vote

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

9. Error in "Refreshing access tokens" section

   The actual docs states that "When you make a request with expired or incorrect authorization credentials, the API returns a WWW-Authenticate header (with an invalid_token error) and a 401 Unauthorized status", but the WWW-Authenticate header is not present in the response.

   Moreover the example shows a kraken endpoint.

   4 votes

   Vote Vote Vote

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

   Vote

   We’ll send you updates on this idea

   Completed  ·  0 comments  ·  Documentation  ·  Delete…  ·  Admin →
   How important is this to you?

   Not at all You must login first! Important You must login first! Critical You must login first!

   We're glad you're here

   Please sign in to leave feedback

   Signed in as (Sign out)

   Close

   Close

10. It is unclear that "Authentication none" means "any token"

    Some endpoint in the docs say "authentication none" leading to some confusion

    https://discuss.dev.twitch.tv/t/getting-top-games-in-python/28256/

    6 votes

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  0 comments  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

11. Possible error/typo

    "Scopes are specified as a space-separated list in the URL scope parameter, when requesting authorization:

    &scope=user:edit+user:read:email"

    Space- or Plus-separated?

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  2 comments  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

12. Update Docs

    The 200 vs. 400 result for revoking tokens is wrong, the API does actually give you a 400 with the message "Invalid Token" if you try to revoke an invalid one.

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

13. Incomplete documentation

    The scopes should be defined in more detail. For instance, from this page, I cannot tell what scope I need to view stream start time, nor can I tell where to go to find this information.

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

14. typo

    Hi might be a typo?At least it was giving me trouble till i fixed it. I am a noob so feel free to ignore. Thanks!

    Line 4 in onchanged:

    Try should be 'try'

    ?

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

15. Unclear Mention of Regex for Bits Parameter

    Hi! For the bits parameter on PRIVMSG, it's not clear to me what this means:

    "The amount of cheer/Bits employed by the user. All instances of these regular expressions:
     /(^|\s)<emote-name>\d+(\s|$)/"

    I'm just not sure what I should be using this regex on or how this fits with the example message provided.

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

16. Incorrect Syntax, Poor quality code, and replace screenshots with embedded code blocks

    1. Incorrect Syntax The JavaScript code in this image is not syntactically correct: https://dev.twitch.tv/docs/assets/uploads/extension-tutorial-11.png

    For example, "Try" is incorrectly capitalized.

    1. Example code is poor quality I referenced the example code for step 1 at: https://github.com/sonia145/extensions-101/blob/step-1/config.js

    It's extremely messy with lots of lines commented out. There are about 13 commented out console.log statements.

    1. Replace screenshots with embedded code blocks

    This page would be greatly improved by replacing the GitHub Gist screenshots with actual embedded JavaScript code blocks.

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

17. broadcaster_name not noted in return values of Get Channel info

    https://dev.twitch.tv/docs/api/reference#get-channel-information

    Omits the description of "broadcastername" and as per https://github.com/twitchdev/issues/issues/3 it's the "dISpLaYNaME" of the caster not the username.

    So we have to do a second lookup to get the login for embed purposes

    6 votes

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  1 comment  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

18. [TYPO] EventSub channel.update docs

    Channel Update Notification Example states both user_id and user_name are returned, when actually it returns broadcaster_user_id and broadcaster_user_name

    Ref: https://dev.twitch.tv/docs/eventsub/eventsub-subscription-types#channelupdate

    2 votes

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  0 comments  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

19. Documentation still outdated for helix requirements

    Even tho https://twitch.uservoice.com/forums/310213-developers/suggestions/40340764-add-client-id-headers-to-examples is marked as completed the docs are still 90% outta date for helix changes (According to Barry)

    https://dev.twitch.tv/docs/api/guide#rate-limits still talks about not provided tokens

    https://dev.twitch.tv/docs/api#step-2-sample-code still doesn't use a OAuth token

    https://dev.twitch.tv/docs/api#step-3-results Is incorrect because step 2 doesn't use a OAuth token

    8 votes

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    Completed  ·  2 comments  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

20. Don't mention NPM

    Under "Run the Chatbot Locally", npm comes with node.js. Saying to install both can be confusing when there is no download option for npm.

    1 vote

    Vote Vote Vote

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close

    Vote

    We’ll send you updates on this idea

    0 comments  ·  Documentation  ·  Delete…  ·  Admin →
    How important is this to you?

    Not at all You must login first! Important You must login first! Critical You must login first!

    We're glad you're here

    Please sign in to leave feedback

    Signed in as (Sign out)

    Close

    Close
    Completed  ·  AdminJon Bulava (Developer Advocate Lead, Twitch) responded

    Thanks for mentioning this! We’ve updated the instructions for today’s docs deployment.