125 results found
-
Add common (and uncommon) error responses from API request I received an error I have never seen before and it got me thinking it would be nice to have some documentation on various error messages like "Insufficient authorization in token". Other errors are clear and straight forwards like "missing X scope" however some are vague and unclear.
2 votes -
Improve documentation for WebHooks' hub.secret property The hub.secret property needs far more explaining of how the secret is generated:
"The X-Hub-Signature header is generated by sha256(secret, notification_bytes)"
It should say something along the lines of
"The X-Hub-Signature header is generated by using HMAC sha256 with the provided secret being the one specified in hub.secret: hmac(sha256, hubsecret).hash(notificationbody)"
2 votes -
How to send a basic API GET request with ajax or postman Unhelpful page. I want to send an API request to test through Postman, but I do not understand what format to put it in. It is asking for an OAuth token, but that request does not mention anything about that. Very confusing.
2 votes -
Expand on V5 to Helix mappings the V5 scope 'user_read' is not listed here. In the migration document it suggests that that is equivalent to the helix scope user:read:email. Is that correct?
Is there a V5 scope that matches the new helix user:read:broadcast
2 votes -
Document how join and authentication limits apply to anonymous connections. https://dev.twitch.tv/docs/irc/guide#command--message-limits says:
- 20 authenticate attempts per 10 seconds per user (200 for verified bots)
- 20 join attempts per 10 seconds per user (2000 for verified bots)however it's unclear how these limits apply to anonymous connections. Is there no limit to join attempts at all when you have authenticated as an anonymous user? And do authentication attempts for anonymous users (NICK justinfan12345) count towards the rate limit?
2 votes -
Split the Helix API reference into sub-categories As the Helix API reference page (https://dev.twitch.tv/docs/api/reference) is continuing to grow it it is starting to become unwieldly with the number of entries.
It would be beneficial to the docs to create sections for different areas of the API. Appropriate names for the sections are already listed in the API, as at the top of the reference page is a table that has a 'Resource' column which would be perfect for this usage, and that table can remain at the root reference page so that devs can see at a glance what endpoints are in what section, then…
2 votesThis has been on the roadmap, and is planned for early 2021.
-
onTransactionComplete trigger result unclear The use of bullet points reads and the "and" tacked onto the end of the first bullet point makes it unclear
The wording should be revised so it's more obvious that "onTransactionComplete" is to be sent to instances where the userID matches the userID that initiated.
Since the first bullet point is superflous, since the userID of the first bullet point is also matched by the second bullet point.
2 votes -
VIP scope mistake? Hey, it says "/vip /unvip" is under "channel:moderate" scope, wouldn't that be moderator status? because I'm sure moderators can't grant/remove VIP status to a user. Or am I wrong?
2 votes -
"Registering your App" an Extension is also an App https://dev.twitch.tv/docs/authentication
Says
Authentication involves: Registering your app to obtain a client ID and client secret. Getting a token. This includes specifying scopes, the permissions your app requires. Sending the token in your API request, to authenticate API requests.But doesn't mention that an Extension is also an Application
This docs fix would be needed on other pages where "registering an app" is mentioned
2 votes -
Document exact what triggers `viewer.onChanged` https://dev.twitch.tv/docs/extensions/reference#helper-viewer
SNIPPET STARTS
onChanged
Twitch.ext.viewer.onChanged: void function(callback: Function())This function binds a callback will be invoked when the viewer’s status changes (e.g. if a viewer subscribes and changes their subscription status).
SNIPPET ENDS
Cannot tell if broken or only triggers on subscription status change.
IE is it supposed to trigger on
rolechanges? If so it's bugged, if not the documentation needs to document what does cause onChanged to be called2 votes -
Custom Rewards limit? Pagination Support
None.
There is a limit of only 50 Custom Rewards on a channel at a time.It's unclear if that means 50 active rewards or 50 total rewards. It should be more plain text/clear.
The help article
https://help.twitch.tv/s/article/making-the-most-of-channel-points?language=en_US
doesn't mentioned this limit either.
2 votes -
Userstate in IRC is out of date in docs This is out of date. Update it please.
2 votes -
Inaccurate info in instrcutions It appears that the Glitch file has been changed! I couldn't get the !dice command to work, until i figured that the command had been changed to !d20 along with the number of sides changed to 20. Or maybe this was a ploy.... to help me understand coding better... Thanks!
2 votes -
Documentation is misleading The example and/or documentation of the "Channel Points Event Message" seem to be wrong/misleading, because the example reply does not match the structure of "Message Parameters: All Messages"
2 votes -
Modify Channel Information says "Query parameters" example post says JSON blob https://dev.twitch.tv/docs/api/reference#modify-channel-information
The example calls uses JSON, but the documentation talks about Query String/URL encoded form.
Docs should cover both possibilities and examples should cover both methods
2 votes -
Embed documentation doesn't mention the SSL requirment https://dev.twitch.tv/docs/embed/ and it's child pages mention the requirements for parent but never SSL
2 votes -
don't assume gender of viewers in documentation Extensions Manager Overview -> Capabilities -> Request Identity Link
Description refers to viewer as a male ('his'). This is likely to offend some people?
2 votes -
Change description of broadcaster_id in create clip The description of the broadcaster_id inside of the Create Clip endpoint is very confusing because it states that this is the id of the stream but it really is the id of the broadcaster as the name suggests.
2 votes -
Wording on refreshing a token is confusing https://dev.twitch.tv/docs/authentication#refreshing-access-tokens
"
How to Refresh
To refresh a token, you need an access token/refresh token pair coming from a body. For example:
"You need only the "refresh token" and "client secret"
You can lose the access token, and still get a new token if you have a refresh_token
2 votes -
Helper: viewer is misleading as the viewer object is populated on all views not just the channel page https://dev.twitch.tv/docs/extensions/reference#helper-viewer
The Twitch.ext.viewer object is a collection of info about the twitch viewer that is watching the channel page where your extension is activated. It will only be populated if the viewer is logged in, and only after the `onAuthorized` callback has been called. Accessing its properties will otherwise return `null`.Should be
The Twitch.ext.viewer object is a collection of info about the twitch user that is watching the extension view.Or something, as the
viewerhelper object exists on all views!2 votes
- Don't see your idea?