core Services backend for everyone. Maintaining custom logic and libraries for

over 100 services is taking too much of this focus away.

[codeclimate]: https://github.com/github/github-services/blob/master/lib/services/codeclimate.rb

[cf]: https://github.com/github/github-services/blob/master/lib/services/campfire.rb

[codeclimate]: https://github.com/github/github-services/blob/fbc0db24b8b7685b2058462181d928a5f2a0a448/lib/services/codeclimate.rb

[cf]: https://github.com/github/github-services/blob/fbc0db24b8b7685b2058462181d928a5f2a0a448/lib/services/campfire.rb

All of this communication is funneled back to our chat rooms. You don't need to

build your own CI setup to use this example.

You can always rely on[third-party services][integrations].

You can always rely on[GitHub integrations][integrations].

[deploy API]:/v3/repos/deployments/

[status API]:/v3/repos/statuses/

* In the meantime, Heaven also notifies everyone about the build, via[Hubot][hubot] sitting in our chat rooms

That's it! You don't need to build your own deployment setup to use this example.

You can always rely on[third-party services][integrations].

You can always rely on[GitHub integrations][integrations].

[deploy API]:/v3/repos/deployments/

[status API]:/guides/building-a-ci-server

[guid]:http://en.wikipedia.org/wiki/Globally_unique_identifier

[hub-signature]:https://github.com/github/github-services/blob/f3bb3dd780feb6318c42b2db064ed6d481b70a1f/lib/service/http_helper.rb#L77

[ping-event-url]:/webhooks/#ping-event

[webhook-events]:/webhooks/#events

[event-types]:/v3/activity/events/types/

Keep in mind that GitHub is never actually accessing your servers. It's up to

your 3rd party integration to interact with deployment events. This allows for

[github-services](https://github.com/github/github-services)integrations as

[GitHub integrations](https://github.com/integrations) as

well as running your own systems depending on your use case. Multiple systems

can listen for deployment events, and it's up to each of those systems to

decide whether or not they're responsible for pushing the code out to your

Name | Type | Description

-----|------|--------------

`name`|`string` |**Required**. Use`web` for a webhook or use the name of a valid service. (See <ahref='https://api.github.com/hooks'data-proofer-ignore>/hooks</a> for the list of valid service names.)

`config`|`object` |**Required**. Key/value pairs to provide settings for this hook. These settings vary betweenthe servicesand are defined in the[github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON`true`/`false` values will be converted automatically.

`config`|`object` |**Required**. Key/value pairs to provide settings for this hook. These settings vary betweenhooksand some are defined in the[github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON`true`/`false` values will be converted automatically.

`events`|`array` | Determines what events the hook is triggered for. Default:`["push"]`

`active`|`boolean` | Determines whether the hook is actually triggered on pushes.

To create[a webhook](/webhooks),[the following fields are required](https://github.com/github/github-services/blob/master/lib/services/web.rb#L4-11) by the`config`:

To create[a webhook](/webhooks), the following fields are required by the`config`:

*`url`: A required string defining the URL to which the payloads will be delivered.

*`content_type`: An optional string defining the media type used to serialize the payloads. Supported values include`json` and`form`. The default is`form`.

*`secret`: An optional string that's passed with the HTTP requests as an`X-Hub-Signature` header. The value of this header is computed as the[HMAC hex digest of the body, using the`secret` as the key][hub-signature].

*`secret`: An optional string that's passed with the HTTP requests as an`X-Hub-Signature` header. The value of this header is computed as the HMAC hex digest of the body, using the`secret` as the key.

*`insecure_ssl`: An optional string that determines whether the SSL certificate of the host for`url` will be verified when delivering payloads. Supported values include`"0"` (verification is performed) and`"1"` (verification is not performed). The default is`"0"`.

Here's how you can create a hook that posts payloads in JSON format:

Name | Type | Description

-----|------|--------------

`config`|`object` | Key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary betweenthe servicesand are defined in the[github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON`true`/`false` values will be converted automatically.

`config`|`object` | Key/value pairs to provide settings for this hook. Modifying this will replace the entire config object. These settings vary betweenhooksand some are defined in the[github-services](https://github.com/github/github-services) repository. Booleans are stored internally as "1" for true, and "0" for false. Any JSON`true`/`false` values will be converted automatically.

`events`|`array` | Determines what events the hook is triggered for. This replaces the entire array of events. Default:`["push"]`

`add_events`|`array` | Determines a list of events to be added to the list of events that the Hook triggers for.

`remove_events`|`array` | Determines a list of events to be removed from the list of events that the Hook triggers for.

``hub.mode``|`string` |**Required**. Either`subscribe` or`unsubscribe`.

``hub.topic``|`string` |**Required**. The URI of the GitHub repository to subscribe to. The path must be in the format of`/:owner/:repo/events/:event`.

``hub.callback``|`string` | The URI to receive the updates to the topic.

``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.

``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[the PubSubHubbub documentation][pshb-secret] for more details.

[guid]:http://en.wikipedia.org/wiki/Globally_unique_identifier

[pubsub]:https://github.com/pubsubhubbub/PubSubHubbub

[post-receive]:http://help.github.com/post-receive-hooks/

[ruby-secret]:https://github.com/github/github-services/blob/14f4da01ce29bc6a02427a9fbf37b08b141e81d9/lib/services/web.rb#L47-L50

[hub-signature]:https://github.com/github/github-services/blob/f3bb3dd780feb6318c42b2db064ed6d481b70a1f/lib/service/http_helper.rb#L77

[pshb-secret]:https://pubsubhubbub.github.io/PubSubHubbub/pubsubhubbub-core-0.4.html#authednotify

[events-url]:/webhooks/#events

[ping-event-url]:/webhooks/#ping-event

hook_id | The ID of the webhook that triggered the ping |

hook | The[webhook configuration][repo-hooks-show] |

In addition to webhooks, we also offer the ability to install pre-rolled

integrations for a variety of existing services. These services[are contributed

and maintained by the Open Source community][github-services].

Service hooks are installed and configured in a similar fashion as webhooks.

When[creating a hook][webhooks-guide-create], just set the`:name` parameter to

a service name instead of "web" (for webhook). The main differences to keep in

mind between webhooks and service hooks are:

- Service hooks cannot be installed on organizations, only repositories.

- You can only install a one service per integrator for a repository, whereas

multiple webhooks can be installed on each organization/repository.

- Each service hook only supports a specific set of events, depending on the

services implementation.

- Each service has its own unique set of configuration options.

To see a full list of available services, their supported events, and

configuration options, check out <a href='https://api.github.com/hooks'

data-proofer-ignore>https://api.github.com/hooks</a>. Documentation for all

service hooks can be found in the[docs directory][github-services-docs] of the

github-services repository.

**Note:** If you are building a new integration, you should build it as webhook.

We suggest creating an[OAuth application][oauth-applications] to automatically

install and manage your users' webhooks. We will no longer be accepting new

services to the[github-services repository][github-services].

[service-hooks-section]:#service-hooks

[events-section]:#events

[wildcard-section]:#wildcard-event

[payloads-section]:#payloads

[webhooks-guide-create]:/webhooks/creating/

[org-hooks]:/v3/orgs/hooks/

[repo-hooks]:/v3/repos/hooks/

[repo-hooks-show]:/v3/repos/hooks/#get-single-hook

[event-types-status]:/v3/activity/events/types/#statusevent

[event-types-team_add]:/v3/activity/events/types/#teamaddevent

[event-types-watch]:/v3/activity/events/types/#watchevent

[github-services]:https://github.com/github/github-services

[github-services-docs]:https://github.com/github/github-services/tree/master/docs

[oauth-applications]:/v3/oauth/

When your secret token is set, GitHub uses it to create a hash signature with each payload. You can find details on the implementation[in our Ruby implementation][ruby-secret].

When your secret token is set, GitHub uses it to create a hash signature with each payload.

This hash signature is passed along with each request in the headers as`X-Hub-Signature`. Suppose you have a basic server listening to webhooks that looks like this:

* Using a plain`==` operator is**not advised**. A method like[`secure_compare`][secure_compare] performs a "constant time" string comparison, which renders it safe from certain timing attacks against regular equality operators.

[ruby-secret]:https://github.com/github/github-services/blob/14f4da01ce29bc6a02427a9fbf37b08b141e81d9/lib/services/web.rb#L47-L50

[secure_compare]:http://rubydoc.info/github/rack/rack/master/Rack/Utils.secure_compare