Revise webhook REST API intro text (#20293)

This commit is contained in:
Lucas Costi 2021-07-13 10:09:59 +10:00 коммит произвёл GitHub
Родитель 7d9c76cf72
Коммит c74ae85d55
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
4 изменённых файлов: 8 добавлений и 5 удалений

Просмотреть файл

@ -69,7 +69,7 @@ Be sure to replace stubbed endpoints with production endpoints before deploying
{% ifversion fpt or ghes > 2.22 or ghae %}
## Webhooks
{% data reusables.webhooks.webhooks-rest-api-links %}
A {% data variables.product.prodname_github_app %}'s webhook allows you to receive HTTP `POST` payloads whenever certain events happen for an app. {% data reusables.webhooks.webhooks-rest-api-links %}
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %}

Просмотреть файл

@ -41,7 +41,7 @@ The token used to authenticate the call must have the `admin:org` scope in order
## Webhooks
Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen within the organization. Subscribing to these events makes it possible to build integrations that react to events on {% data variables.product.product_name %}. {% data reusables.webhooks.webhooks-rest-api-links %}
Organization webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in an organization. {% data reusables.webhooks.webhooks-rest-api-links %}
For more information on actions you can subscribe to, see "[{% data variables.product.prodname_dotcom %} event types](/developers/webhooks-and-events/github-event-types)."

Просмотреть файл

@ -304,10 +304,12 @@ to the information provided in your repository graph. For more information, see
## Webhooks
The Repository Webhooks API allows repository admins to manage the post-receive hooks for a repository. {% data reusables.webhooks.webhooks-rest-api-links %} Webhooks can be managed using the JSON HTTP API, or the [PubSubHubbub](#pubsubhubbub) API.
Repository webhooks allow you to receive HTTP `POST` payloads whenever certain events happen in a repository. {% data reusables.webhooks.webhooks-rest-api-links %}
If you would like to set up a single webhook to receive events from all of your organization's repositories, see our API documentation for [Organization Webhooks](/rest/reference/orgs#webhooks).
In addition to the REST API, {% data variables.product.prodname_dotcom %} can also serve as a [PubSubHubbub](#pubsubhubbub) hub for repositories.
{% for operation in currentRestOperations %}
{% if operation.subcategory == 'webhooks' %}{% include rest_operation %}{% endif %}
{% endfor %}

Просмотреть файл

@ -1,4 +1,5 @@
The repository, organization, and app webhook REST APIs enable you to create, update, delete, and ping webhooks.{% ifversion fpt or ghes > 3.2 or ghae %} You can use this API to list webhook deliveries for a webhook, or get and redeliver an individual delivery for a webhook, which can be integrated into an external app or service.{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see:
The webhook REST APIs enable you to manage repository{% ifversion ghes < 3.0 %} and organization{% else %}, organization, and app{% endif %} webhooks.{% ifversion fpt or ghes > 3.2 or ghae %} You can use this API to list webhook deliveries for a webhook, or get and redeliver an individual delivery for a webhook, which can be integrated into an external app or service.{% endif %}{% ifversion fpt or ghes > 2.22 or ghae %} You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret.{% endif %} For more information, see:
- [Repository Webhooks REST API](/rest/reference/repos#webhooks)
- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% ifversion fpt or ghes > 2.22 or ghae %}
- [GitHub App Webhooks REST API](/rest/reference/apps#webhooks){% endif %}
- [{% data variables.product.prodname_github_app %} Webhooks REST API](/rest/reference/apps#webhooks){% endif %}