jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 19:34:15 -05:00
Code Issues Projects Releases Wiki Activity

Use plural variables consistently (#20412)

Browse Source 
* Use plural variables consistently

* Update content/developers/github-marketplace/github-marketplace-overview/about-github-marketplace.md
This commit is contained in:
hubwriter
2021-07-20 17:09:40 +01:00
committed by GitHub
parent b671aaf89f
commit 2d99aee37a
44 changed files with 142 additions and 142 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
content/developers/webhooks-and-events/webhooks/about-webhooks.md
View File

@@ -11,7 +11,7 @@ versions:
topics:
- Webhooks
---
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 allow you to build or set up integrations, such as [{% data variables.product.prodname_github_apps %}](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_apps %}](/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{% ifversion ghes or ghae %} [{% data variables.product.prodname_enterprise %}](/rest/reference/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.

94
content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md
View File

@@ -109,7 +109,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
- Repository webhooks only receive payloads for the `created` and `completed` event types in a repository
- Organization webhooks only receive payloads for the `created` and `completed` event types in repositories
- {% data variables.product.prodname_github_app %}s with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_app %}s with the `checks:write` are automatically subscribed to this webhook event.
- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event.
### Webhook payload object
@@ -133,7 +133,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
- Repository webhooks only receive payloads for the `completed` event types in a repository
- Organization webhooks only receive payloads for the `completed` event types in repositories
- {% data variables.product.prodname_github_app %}s with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_app %}s with the `checks:write` are automatically subscribed to this webhook event.
- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event.
### Webhook payload object
@@ -156,7 +156,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `security_events :read` permission
- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission
### Webhook payload object
@@ -178,7 +178,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`.
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -201,7 +201,7 @@ Webhook events are triggered based on the specificity of the domain you register
### Availability
- {% data variables.product.prodname_github_app %}s with the `content_references:write` permission
- {% data variables.product.prodname_github_apps %} with the `content_references:write` permission
### Webhook payload example
@@ -221,7 +221,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -250,7 +250,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -293,7 +293,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `deployments` permission
- {% data variables.product.prodname_github_apps %} with the `deployments` permission
### Webhook payload object
@@ -318,7 +318,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `deployments` permission
- {% data variables.product.prodname_github_apps %} with the `deployments` permission
### Webhook payload object
@@ -349,7 +349,7 @@ Activity related to a discussion. For more information, see the "[Using the Grap
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `discussions` permission
- {% data variables.product.prodname_github_apps %} with the `discussions` permission
### Webhook payload object
@@ -375,7 +375,7 @@ Activity related to a comment in a discussion. For more information, see "[Using
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `discussions` permission
- {% data variables.product.prodname_github_apps %} with the `discussions` permission
### Webhook payload object
@@ -423,7 +423,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -441,11 +441,11 @@ Key | Type | Description
When someone revokes their authorization of a {% data variables.product.prodname_github_app %}, this event occurs. A {% data variables.product.prodname_github_app %} receives this webhook by default and cannot unsubscribe from this event.
{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_app %}s](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)."
{% data reusables.webhooks.authorization_event %} For details about user-to-server requests, which require {% data variables.product.prodname_github_app %} authorization, see "[Identifying and authorizing users for {% data variables.product.prodname_github_apps %}](/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/)."
### Availability
- {% data variables.product.prodname_github_app %}s
- {% data variables.product.prodname_github_apps %}
### Webhook payload object
@@ -466,7 +466,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -492,7 +492,7 @@ Key | Type | Description
### Availability
- {% data variables.product.prodname_github_app %}s
- {% data variables.product.prodname_github_apps %}
### Webhook payload object
@@ -516,7 +516,7 @@ Key | Type | Description
### Availability
- {% data variables.product.prodname_github_app %}s
- {% data variables.product.prodname_github_apps %}
### Webhook payload object
@@ -536,7 +536,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `issues` permission
- {% data variables.product.prodname_github_apps %} with the `issues` permission
### Webhook payload object
@@ -559,7 +559,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `issues` permission
- {% data variables.product.prodname_github_apps %} with the `issues` permission
### Webhook payload object
@@ -582,7 +582,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
### Webhook payload object
@@ -609,7 +609,7 @@ Activity related to a GitHub Marketplace purchase. {% data reusables.webhooks.ac
### Availability
- {% data variables.product.prodname_github_app %}s
- {% data variables.product.prodname_github_apps %}
### Webhook payload object
@@ -633,7 +633,7 @@ For a detailed description of this payload and the payload for each type of `act
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `members` permission
- {% data variables.product.prodname_github_apps %} with the `members` permission
### Webhook payload object
@@ -655,7 +655,7 @@ For a detailed description of this payload and the payload for each type of `act
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `members` permission
- {% data variables.product.prodname_github_apps %} with the `members` permission
### Webhook payload object
@@ -700,7 +700,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
### Webhook payload object
@@ -723,7 +723,7 @@ Key | Type | Description
{% ifversion ghes or ghae %}
- GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %}
- Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events
- {% data variables.product.prodname_github_app %}s with the `members` permission
- {% data variables.product.prodname_github_apps %} with the `members` permission
### Webhook payload object
@@ -749,7 +749,7 @@ Key | Type | Description
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `organization_administration` permission
- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission
### Webhook payload object
@@ -798,7 +798,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `pages` permission
- {% data variables.product.prodname_github_apps %} with the `pages` permission
### Webhook payload object
@@ -823,7 +823,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s receive a ping event with an `app_id` used to register the app
- {% data variables.product.prodname_github_apps %} receive a ping event with an `app_id` used to register the app
### Webhook payload object
@@ -849,7 +849,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
### Webhook payload object
@@ -871,7 +871,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
### Webhook payload object
@@ -893,7 +893,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
### Webhook payload object
@@ -915,7 +915,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
### Webhook payload object
@@ -938,7 +938,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
### Webhook payload object
@@ -963,7 +963,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
### Webhook payload object
@@ -985,7 +985,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
### Webhook payload object
@@ -1014,7 +1014,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -1053,7 +1053,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `contents` permission
- {% data variables.product.prodname_github_apps %} with the `contents` permission
### Webhook payload object
@@ -1075,7 +1075,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
### Availability
- {% data variables.product.prodname_github_app %}s must have the `contents` permission to receive this webhook.
- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook.
### Webhook payload example
@@ -1090,7 +1090,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
- Repository webhooks receive all event types except `deleted`
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `metadata` permission receive all event types except `deleted`
- {% data variables.product.prodname_github_apps %} with the `metadata` permission receive all event types except `deleted`
### Webhook payload object
@@ -1159,7 +1159,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `secret_scanning_alerts:read` permission
- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission
### Webhook payload object
@@ -1182,7 +1182,7 @@ Activity related to a security advisory. A security advisory provides informatio
### Availability
- {% data variables.product.prodname_github_app %}s with the `security_events` permission
- {% data variables.product.prodname_github_apps %} with the `security_events` permission
### Webhook payload object
@@ -1250,7 +1250,7 @@ You can only create a sponsorship webhook on {% data variables.product.prodname_
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `statuses` permission
- {% data variables.product.prodname_github_apps %} with the `statuses` permission
### Webhook payload object
@@ -1278,7 +1278,7 @@ Key | Type | Description
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `members` permission
- {% data variables.product.prodname_github_apps %} with the `members` permission
### Webhook payload object
@@ -1309,7 +1309,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `members` permission
- {% data variables.product.prodname_github_apps %} with the `members` permission
### Webhook payload object
@@ -1350,7 +1350,7 @@ The event’s actor is the [user](/rest/reference/users) who starred a repositor
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_app %}s with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
### Webhook payload object
@@ -1371,7 +1371,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS
### Availability
- {% data variables.product.prodname_github_app %}s must have the `contents` permission to receive this webhook.
- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook.
### Webhook payload example
@@ -1385,7 +1385,7 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o
### Availability
- {% data variables.product.prodname_github_app %}s with the `actions` or `contents` permissions.
- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions.
### Webhook payload object