-
Notifications
You must be signed in to change notification settings - Fork 58.2k
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
Clarify that X-GitHub-Delivery
is unique per event, not per delivery
#32822
Comments
Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@minusworld Thank you for opening this issue! I'll get this triaged for review ✨ |
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀 |
The cc: @skedwards88 |
Thanks for the confirmation, Kevin, and thanks for this detailed and clear issue @minusworld ! You or anyone else is welcome to open a PR to clarify this:
|
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
This comment was marked as spam.
Hi @nguyenalex836. I made a pull request for this issue. It's #33184. |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/webhooks/webhook-events-and-payloads#delivery-headers
https://docs.github.com/en/webhooks/using-webhooks/best-practices-for-using-webhooks#use-the-x-github-delivery-header
What part(s) of the article would you like to see updated?
https://docs.github.com/en/webhooks/webhook-events-and-payloads#delivery-headers
https://docs.github.com/en/webhooks/using-webhooks/best-practices-for-using-webhooks#use-the-x-github-delivery-header
Additional information
Hi there!
I was experiencing a puzzling issue for a while where were receiving two webhook event payloads with the same
X-GitHub-Delivery
GUID. At first, I assumed it was our infrastructure duplicating something because I assumed that all payloads from GitHub would have a uniqueX-GitHub-Delivery
. However, upon further experimentation, I was able to create a scenario which sends two different payloads with the sameX-GitHub-Delivery
GUID by creating two GitHub Apps. This leads me to believe thatX-GitHub-Delivery
is unique per GitHub event, not unique per delivery as the documentation implies. Further, this means the guidance in this section is nuanced because there are cases where I want to handle the webhook differently based on which App is sending the event, which means excluding payloads based onX-GitHub-Delivery
isn't always valid.Below are some screenshots showing the same
X-GitHub-Delivery
from two different GitHub Apps.1. I created two GitHub Apps to send webhook events to two different callback URLs.
2. This screenshot shows the same
X-GitHub-Delivery
GUID routed to two destinations.Additionally, it shows unique Amazon CloudFront and Amazon Load Balancer IDs for the web request.
3. This screenshot shows the same
X-GitHub-Delivery
with two differentapp_id
s.The text was updated successfully, but these errors were encountered: