Skip to content
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

What's the difference between x-request-id and x-github-delivery? #579

Open
ScottChapman opened this issue Jun 1, 2021 · 6 comments
Open
Labels
Status: Blocked Blocked by GitHub's API or other external factors Type: Support Any questions, information, or general needs around the SDK or GitHub APIs

Comments

@ScottChapman
Copy link

I see both referenced in the docs and used as an id. But not clear what they are exactly. I suspect one is unique to the event, but not sure which one, and then what the other one is!

@ScottChapman ScottChapman added the Type: Support Any questions, information, or general needs around the SDK or GitHub APIs label Jun 1, 2021
@gr2m
Copy link
Contributor

gr2m commented Jun 1, 2021

If I recall correctly, x-github-delivery is the event ID. An event is something like "a new pull request was created". A single event can create multiple webhook event requests though, and each webhook request gets its own ID. That's what X-GitHub-Hook-ID is, I think. I don't think we use that anywhere though.. I'm not sure where you have seen x-request-id in the context of webhooks? It's usually set on API responses, I don't think that it's set on webhook requests

@ScottChapman
Copy link
Author

@gr2m
Copy link
Contributor

gr2m commented Jun 1, 2021

It's a very good question. I don't see the header listed on https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#delivery-headers, but maybe it should?

I see the header when testing with smee.io. I also see x-request-start which I think should be documented as well. Could you maybe file an issue on https://github.com/github/docs and ask about that? You can reference this issue and ping me in it

@ScottChapman
Copy link
Author

smee isn't adding anything is it?

@gr2m
Copy link
Contributor

gr2m commented Jun 1, 2021

No

@gr2m
Copy link
Contributor

gr2m commented Jun 9, 2021

blocked by github/docs#7005

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Blocked Blocked by GitHub's API or other external factors Type: Support Any questions, information, or general needs around the SDK or GitHub APIs
Projects
None yet
Development

No branches or pull requests

2 participants