f272eec944
* ran script/remove-unused-assets.js (manually removed unused variables printed by the script) * package-lock * turn elsif into two ifs to prepare for running Liquid deprecation script * ran script/remove-deprecated-enterprise-version-markup.js --release 2.14 (ONLY UPDATES LINE BREAKS ETC.) * ran script/remove-deprecated-enterprise-version-markup.js --release 2.15 * ran script/remove-deprecated-enterprise-version-markup.js --release 2.17 * ran script/remove-deprecated-enterprise-version-markup.js --release 2.18 * update hardcoded test * Update content/github/collaborating-with-issues-and-pull-requests/filtering-files-in-a-pull-request.md Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * add currentVersion is NOT free-pro-team to conditional, to make sure the deprecation script does the right thing when it is time to deprecate 2.21 Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com>
34 lines
2.2 KiB
Markdown
34 lines
2.2 KiB
Markdown
---
|
|
title: About webhooks
|
|
intro: Learn the basics of how webhooks work to help you build and set up integrations.
|
|
redirect_from:
|
|
- /webhooks
|
|
versions:
|
|
free-pro-team: '*'
|
|
enterprise-server: '*'
|
|
---
|
|
|
|
|
|
Webhooks allow you to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), which subscribe to certain events on GitHub.com. When one of those events is triggered, we'll send a HTTP POST payload to the webhook's configured URL. Webhooks can be used to update an external issue tracker, trigger CI builds, update a backup mirror, or even deploy to your production server. You're only limited by your imagination.
|
|
|
|
Webhooks can be installed on{% if currentVersion != "free-pro-team@latest" %} a [{% data variables.product.prodname_ghe_server %} instance](/v3/enterprise-admin/global_webhooks/),{% endif %} an [organization][org-hooks], a specific [repository][repo-hooks], or a {% data variables.product.prodname_github_app %}. Once installed, the webhook will be sent each time one or more subscribed events occurs.
|
|
|
|
You can create up to {% if currentVersion != "free-pro-team@latest" %}250{% else %}20{% endif %} webhooks for each event on each installation target {% if currentVersion != "free-pro-team@latest" %}({% data variables.product.prodname_ghe_server %} instance, specific organization, or specific repository).{% else %}(specific organization or specific repository).{% endif %}
|
|
|
|
### Events
|
|
|
|
{% data reusables.webhooks.webhooks_intro %}
|
|
|
|
Each event corresponds to a certain set of actions that can happen to your organization and/or repository. For example, if you subscribe to the `issues` event you'll receive detailed payloads every time an issue is opened, closed, labeled, etc.
|
|
|
|
See "[Webhook event payloads](/webhooks/event-payloads)" for the list of available webhook events and their payloads.
|
|
|
|
### Ping event
|
|
|
|
{% data reusables.webhooks.ping_short_desc %}
|
|
|
|
For more information about the `ping` event webhook payload, see the [`ping`](/webhooks/event-payloads/#ping) event.
|
|
|
|
[org-hooks]: /v3/orgs/hooks/
|
|
[repo-hooks]: /v3/repos/hooks/
|