163 results found
-
Publish Official Typescript Typing's for all Data Models It would be very easy to build and design for if there were official typing for all data endpoints. The data between all the different API's for the same data isn't consistent, and with event sub, since it no longer relies on the underlying Helix endpoint, that data can now be different too. This will also mitigate typos on the docs which causes huge headaches when trying to code for API responses and the data not working, or missing fields. The typing can specify which fields are required and which are optional, so when designing your app, you can easily…
3 votes -
Document API and IRC tags for replies Web chat users got access to the new "replies" feature, where you can mark your message to be a reply of another message.
My suggestion is to add official documentation on how third parties can use this feature (for sending messages and for parsing received messages to be a reply)
7 votes -
docs revision Can you please double check the meaning of the sentences covered in this page (ex: Send the user you want to authenticate to your registered redirect URI. -> you dont't send them to the redirect URI but to the Twitch uri under the cited pharagraph) And the 'token+idtoken' is not equal to 'token%20idtoken' (the 'token id_token' is) the '+' signs encoded to '%2B' which trows an error whereas the ' ' (space) encoded to '%20' which returns the desired result.
1 vote -
Update References to v5 API There are reference to V5 API here to get user and channel ID.
Combined with the GitHub Sample at https://github.com/twitchdev/pubsub-javascript-sample that is still using it this is very confusing to get to work.
Suggest to update the sample and this article to reference the helix APIs instead.4 votes -
Host example code in an official Twitch organization on GitHub This tutorial looks very unprofessional.
The example GitHub repository is not available from an official Twitch source, but lives in someone's personal
account at:
https://github.com/sonia145These GitHub organizations would be better alternatives:
https://github.com/twitchtv
https://github.com/twitchdev3 votes -
make the docs better and more simple to understand for new users. this site is awfull cause the explenation of the api is trash.
1 vote -
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?
4 votes -
VOD audio track URL Document URL or port for streaming VOD audio track too!
For context, I'm livestreaming using FFMPEG because OBS is quite heavy if I want to stream in my Chromebook (btw I'm using NixOS instead of ChromeOS)1 vote -
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.
3 votes -
Fix the example GitHub repo to better correlate to the documentation on this page Provide a link to the referenced branch associated with each step.
There are no branches for steps 3 and 4. The existing branches don't correlate to the code presented for each step on this page.
And there's messy commented out code in all of the files on GitHub.Also, 4 steps are explained, and then the last sentence in this doc mentions the Step 1 branch
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…
3 votesThis has been on the roadmap, and is planned for early 2021.
-
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 -
Get Custom Reward Redemptions "missing redemption status" Declares that only broadcasterid and rewardid are required.
A call to
results in
{
"error": "Bad Request",
"status": 400,
"message": "missing redemption status"
}The documentation lists status as not required
3 votes -
Documentation is misleading at best This information is incorrect. The panel and component extensions fail when self hosted with https making it useless to try and test on twitch as it does not function at all. Please update this page or remove it so that people do not attempt to make extensions only to have your code completely ruin the process.
1 vote -
Add existing IRC WHISPER command to IRC documentation The IRC gateway passes whispers using the WHISPER code:
[16:36:15] [@] @badges=bits-charity/1;color=#3E2E18;display-name=foo;emotes=;message-id=2;thread-id=21001676_470220570;turbo=0;user-id=2109996;user-type= :foo!foo!foo.twitch.tv WHISPER myuser :this is a whisper
But I am unable to find any reference to that code on https://dev.twitch.tv/docs/irc/commands where I would expect it, or any other documentation page under the "Chatbots and IRC" section.
I would suggest adding the WHISPER command to the list of commands at the top of the page on the IRC: Commands section, something similar to:
WHISPER Receive a Whisper message from another user
and then the prototype at the bottom, to include the fact that it appears the WHISPER command is…
15 votes -
Capabilities sub pages no clear capability needed It should be more obvious that
Twitch IRC: Commands
needs the commands capability,Twitch IRC: Tags
needs the tags capability, Membership page needs the membership capability.IE:
Literally add a paragraph at the top to the effect of
The Twitch IRC responses outlined on this page requires the connection to have requested the $whatever capability as outlined on the https://dev.twitch.tv/docs/irc/guide#twitch-irc-capabilities Capabilities section of the guide.
4 votes -
IRC Landing page/guide -> twitchapps.com https://dev.twitch.tv/docs/irc
As a getting started/IRC docs landing page is confusing new developers
As it references
The token to authenticate your chatbot with Twitch's servers. Generate this with https://twitchapps.com/tmi/ (a Twitch community-driven wrapper around the Twitch API), while logged in to your chatbot account. The token will be an alphanumeric string.
And doesn't reference anything about the "right way" to auth/scopes needed
Until the end of the guide.
Authentication using not a third party site should be more prevalent in the guide.
3 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 -
EventSub subscriptions are missing the optional "after" parameter for pagination There is no explanation on how to use the pagination cursor for EventSub subscription GET requests.
Apparently the cursor can be appended in a request as the "after" parameter, but I feel this should be stated in the optional query parameters, as is the case in the Twitch API reference (e.g. https://dev.twitch.tv/docs/api/reference#get-extension-analytics).1 vote
- Don't see your idea?