Skip to content

Commit a6bf28a

Browse files
committed
document headers we send to payloads
1 parent a6d39b9 commit a6bf28a

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

content/v3/repos/hooks.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,16 @@ or the [PubSubHubbub API](#pubsubhubbub).
3333

3434
POST /repos/:owner/:repo/hooks
3535

36+
### Webhook Headers
37+
38+
GitHub will send along a few HTTP headers to differentiate between event types and payload identifiers.
39+
40+
Name | Description
41+
-----|-----------|
42+
`HTTP_X_GITHUB_EVENT` | The [event type](#events) that was triggered.
43+
`HTTP_X_GITHUB_DELIVERY` | A [guid][guid] to identify the payload and event being sent.
44+
`HTTP_X_GITHUB_SIGNATURE` | The value of this header is computed as the HMAC hex digest of the body, using the `secret` config option as the key.
45+
3646
### Parameter
3747

3848
Name | Type | Description
@@ -197,4 +207,4 @@ Name | Type | Description
197207
[hub-signature]: https://github.com/github/github-services/blob/f3bb3dd780feb6318c42b2db064ed6d481b70a1f/lib/service/http_helper.rb#L77
198208
[pshb-secret]: http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#authednotify
199209
[events-url]: /webhooks/#events
200-
[ping-event-url]: /webhooks/#ping-event
210+
[ping-event-url]: /webhooks/#ping-event

0 commit comments

Comments
 (0)