-
Notifications
You must be signed in to change notification settings - Fork 40
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Adds Webhook Documentation #205
base: master
Are you sure you want to change the base?
Conversation
@cforbes Overall this looks amazing. There is one thing that I believe webhooks are going to be a very crucial and important feature. I see it is currently listed at the bottom of the docs under SDK and errors. Can we possibly move this up. In my opinion, the order should be as follow: Available Endpoints |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these callbacks going to be signed? If not, is there any good reason why?
Wouldn't want some poor consumer getting smashed with bad data because their callback URL was exposed.
@dominicgunn added a ticket for signing these. It was an oversight, and exactly why we posted these ahead of launch. Thank you very much for the feedback! |
Would it be possible to create and delete multiple webhooks in one call? It'd make more sense if many players must be checked at once. |
Rather than this, I think the plan is to support (and actually potentially
default) expiration. The main use case for wrbhooks (i think) will be
community sites that want to support tournaments.
Also - Should make vg8 tournaments easier to track too.
On Tue, Aug 15, 2017 at 11:02 AM Justin ***@***.***> wrote:
Would it be possible to create and delete multiple webhooks in one call?
It'd make more sense if many players must be checked at once.
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#205 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAADMPuErcufZi4Uw9c22X3yYn3h1By1ks5sYc8hgaJpZM4OivB7>
.
--
Brian Corrigan
Managing Partner / Principal Engineer at MadGlory
<https://www.linkedin.com/company/2657284>
Wb: http://madglory.com <http://www.madglory.com/>
Tw: @madglory
Ph: 518.867.1439
|
We are serving a community tournament with over 200 participants. Is the limitation to 100 hooks fixed? Can you scale it with the token's ratelimit? |
docs/sections.json
Outdated
"12": "_links", | ||
"13": "_sdks", | ||
"14": "_errors" | ||
"12": "_webhooks" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
JSON has broken, let's fix it. (Missing a ,
after "_webhooks").
|
||
This endpoint creates a webhook | ||
|
||
Note: A verification event will be sent to the url (see supported events above). If the request does not succeed, the webhook will not be created. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here we refer to 'supported events', where as previously we referred to 'supported topics'. Should we keep terminology the same?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of things that might need fixing before merging.
What is the retry logic if a callback fails to reach its destination? |
Are there other topics planned for the future? I think topics for when a match starts, or using a spectator name instead of player in tournament servers would be useful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Documentation seems OK, would like more info on retry procedure.
We'll add the retry logic documentation in there. Short summary is that it will retry for several days (i think). We should document the backoff algorithm too. I'll verify this! |
@justin97530 Match start probably won't happen (but you can log a ticket for it!) Spectators is a great one and we can totally do that. |
Any ETA on this? |
Fixes # .
Changes proposed: