Document headers we send to payloads #451
Conversation
|
Definitely the right page, but I think this deserves its own section titled "Receiving hooks" after "Delete a hook", before "Pubsubhubub". We could mention any server requirements and then just move the contents of this PR under that as "Request headers". Thoughts? |
|
@pengwynn Awesome, I'll take that approach. I just wanted to get the discussion going. |
|
|
||
| Name | Description | ||
| -----|-----------| | ||
| `X-GitHub_Event` | The [event type](#events) that was triggered. |
There was a problem hiding this comment.
I think these are X-GitHub-Event based on http://github.com/github/github-services/blob/master/lib/services/web.rb#L22
| @@ -131,6 +131,20 @@ This will trigger a [ping event][ping-event-url] to be sent to the hook. | |||
|
|
|||
| <%= headers 204 %> | |||
|
|
|||
| ## Receiving Webhooks | |||
|
|
|||
| In order for GitHub to send webhooks to your service it needs to be accessible from the internet. We highly suggest using SSL to encrypt the payloads we send to your server. | |||
There was a problem hiding this comment.
I suggest a couple of small tweaks:
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.
|
|
Document headers we send to payloads
I'm not exactly sure where these docs should go but they should go somewhere.
Fixes github/github-services#815