You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 1, 2017. It is now read-only.
Copy file name to clipboardExpand all lines: content/v3/repos/hooks.md
+16-1Lines changed: 16 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -131,6 +131,20 @@ This will trigger a [ping event][ping-event-url] to be sent to the hook.
131
131
132
132
<%= headers 204 %>
133
133
134
+
##Receiving Webhooks
135
+
136
+
In order for GitHub to send Webhook payloads to your service, your server needs to be accessible from the Internet. We also highly suggest using SSL so that we can send encrypted payloads over HTTPS.
137
+
138
+
###Webhook Headers
139
+
140
+
GitHub will send along a few HTTP headers to differentiate between event types and payload identifiers.
141
+
142
+
Name | Description
143
+
-----|-----------|
144
+
`X-GitHub-Event` | The[event type](/v3/activity/events/types/) that was triggered.
145
+
`X-GitHub-Delivery` | A[guid][guid] to identify the payload and event being sent.
146
+
`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.
147
+
134
148
##PubSubHubbub
135
149
136
150
GitHub can also serve as a[PubSubHubbub][pubsub] hub for all repositories.
@@ -191,10 +205,11 @@ Name | Type | Description
191
205
``hub.secret``|`string` | A shared secret key that generates a SHA1 HMAC of the outgoing body content. You can verify a push came from GitHub by comparing the raw request body with the contents of the`X-Hub-Signature` header. You can see[our Ruby implementation][ruby-secret], or[the PubSubHubbub documentation][pshb-secret] for more details.