GitHub Community
GitHub Web Hooks documentation #24312
-
|
Where can I find documentation to triggering webhooks when a comment is created on a PR? Also, where is it explained that a PR is just an issue with code? I just finished 3 hours long search for how to send a GitHub webhook when a comment is created on a PR. I believe I searched the Webhooks documentation through and through, and nowhere, is any mention about the fact that comments on a PR actually trigger the I believe there has to be more information about that fact than that short sentence. There is no way you mention that “a Pull Request is just an Issue with code” only once. Mainly, if the documentation itself states “This may seem counterintuitive at first.”. Also, sorry for being too hostile, but I feel exhasted after searching for such a simple thing for so long, and the authors themselves acknowledged that it is counterintuitive. Yet, they never explained the reasons for it, nor was that information easy to find. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments 1 reply
-
|
Hey @vladmasarik, Thanks for being here, and thanks for taking the time to write this feedback. I can see how is very frustrating to not be able to find clear documentation. Let me see if I can help clarify some of your questions and rest assured I’ll pass on your feedback to our docs team. Here is a link to the current docs for our Webhooks product (https://developer.github.com/webhooks/). These are configured at repository level and the principal is that you can subscribe to events that happen in the given repository and receive a payload representing this, which you can then process as you see fit, storing the data locally or triggering some desired behavior. When you create a hook you designate a URL for this hook. This has to be a publicly exposed endpoint that can receive POST requests. Once you have this you can then configure your hook to either receive form-encoded POST data, or JSON encoded POST data. Finally, you pick the events that you’d like to subscribe to this hook to. When an event occurs, such as a push or triggered when a pull request is https://developer.github.com/v3/activity/events/types/#pushevent
If the event has multiple actions, for instance an issue event might have an event for created, updated, a new label being added etc. Then there is an action key in this payload that denotes what action triggered this event. Once you receive this it’s up to you how you decide to process this, for instance, you might store this in a db or key/value no-db store, you might decide to store all of the data, or just what you need for your personal site - the choice is entirely yours. I hope this helps, and if you have any further questions feel free to reach out. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for so useless answer. This doesn’t help even a bit. I think you misread the OP’s problem completely.
|
Beta Was this translation helpful? Give feedback.
-
A little patience with @AndreaGriffiths11 and less sarcasm would be helpful if you want to solve the problems you've described. Please keep in mind that she is not responsible for the current mess with the way GitHub handles PRs being issues. (Apparently they evolved out of issues, where people would simply open an issue to request that someone pull their branch into the master branch, and new features were added to them over time but GitHub never made PRs into first class objects even after they evolved into something completely different from issues.) Nor is she responsible for the current state of the documentation. She's just trying to help @VladMasarik in any way she can, after him having run into these problems. She was very gracious despite the circumstances. Read her first sentence to see what I mean:
But back to your comments.
That is probably true, but how much of what she missed was explicitly stated? Do you think the responsibility is 100% on her shoulders for understanding him? He wrote
First of all, the sentence doesn't actually work with "to". I think he means "about" or "on". It's harder to understand anyone when you must do mental grammar correction (and guess what they intended). I'm not saying that to criticize @VladMasarik. I know English can be hard to master, and the way each language handles preposition tends to be very different, and this makes it very hard to get them right in any second language. We need to cut all non-native speakers a lot of slack since they are doing a lot of extra work to communicate in a language they didn't learn as infants. I only point this out to show that it gives @AndreaGriffiths11 extra work too on the receiving end of the message. She's already doing extra work to communicate in English, but on top of that she is receiving English with syntax errors, and she's expected to correctly parse it. But this is the smaller issue. The much bigger issue with this sentence is that it's unclear whether it's a real question or a rhetorical question. Is he saying this because he wants an answer? Or to express how hard it is to find the documentation? I think it's a rhetorical question, since he follows it with this question
He knows that a PR is "just an issue with code", and asking where this is documented seems to be meant to show how bad the documentation is. I think that's the case, but I'm no 100% sure if that's his point. But my point to you is: is it really fair to complain that she didn't understand something that is so unclear? If his question was meant to imply his point, and she interpreted it as a straightforward request for information, is that a reason to make sarcastic remarks at her? I don't think so. I think you're probably right about the problems with documentation and the strangeness around PRs on GitHub. (I haven't read the documentation about this so I can't say with certainty.) But shooting the messenger doesn't help solve the problem. Note that she left the conversation open, leaving opportunity for clarifications if they were needed:
When there is misunderstanding in communication, the best next step is to try to bring clarity, not to snipe at the person who innocently misunderstood something. |
Beta Was this translation helpful? Give feedback.
Hey @vladmasarik,
Thanks for being here, and thanks for taking the time to write this feedback. I can see how is very frustrating to not be able to find clear documentation. Let me see if I can help clarify some of your questions and rest assured I’ll pass on your feedback to our docs team.
Here is a link to the current docs for our Webhooks product (https://developer.github.com/webhooks/). These are configured at repository level and the principal is that you can subscribe to events that happen in the given repository and receive a payload representing this, which you can then process as you see fit, storing the data locally or triggering some desired behavior.
When you create a hook you…