jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 11:26:57 -05:00
Code Issues Projects Releases Wiki Activity

Swap in customer-understandable GitHub App permission names (#31376)

Browse Source 
Co-authored-by: skedwards88 <skedwards88@github.com>
This commit is contained in:
Steve Richert
2022-10-03 15:20:10 -04:00
committed by GitHub
parent 0971a6ebf7
commit c3f3b8f177
1 changed files with 46 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -106,7 +106,7 @@ Activity related to a branch protection rule. For more information, see "[About
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration
- {% data variables.product.prodname_github_apps %} with **Administration** repository permission
### Webhook payload object
@@ -161,7 +161,7 @@ Key | Type | Description
- 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_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.
- {% data variables.product.prodname_github_apps %} with **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 **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 **Checks** write permission are automatically subscribed to this webhook event.
### Webhook payload object
@@ -185,7 +185,7 @@ Key | Type | Description
- 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_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.
- {% data variables.product.prodname_github_apps %} with **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 **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 **Checks** write permission are automatically subscribed to this webhook event.
### Webhook payload object
@@ -207,7 +207,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission
- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission
### Webhook payload object
@@ -229,7 +229,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -273,7 +273,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -302,7 +302,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -345,7 +345,7 @@ Webhook events are triggered based on the specificity of the domain you register
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `deployments` permission
- {% data variables.product.prodname_github_apps %} with **Deployments** permission
### Webhook payload object
@@ -370,7 +370,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `deployments` permission
- {% data variables.product.prodname_github_apps %} with **Deployments** permission
### Webhook payload object
@@ -401,7 +401,7 @@ Activity related to a discussion. For more information, see the "[Using the Grap
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `discussions` permission
- {% data variables.product.prodname_github_apps %} with **Discussions** permission
### Webhook payload object
@@ -427,7 +427,7 @@ Activity related to a comment in a discussion. For more information, see "[Using
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `discussions` permission
- {% data variables.product.prodname_github_apps %} with **Discussions** permission
### Webhook payload object
@@ -475,7 +475,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -518,7 +518,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -576,7 +576,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `issues` permission
- {% data variables.product.prodname_github_apps %} with **Issues** permission
### Webhook payload object
@@ -599,7 +599,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `issues` permission
- {% data variables.product.prodname_github_apps %} with **Issues** permission
### Webhook payload object
@@ -622,7 +622,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with **Metadata** permission
### Webhook payload object
@@ -673,7 +673,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_apps %} with the `members` permission
- {% data variables.product.prodname_github_apps %} with **Members** permission
### Webhook payload object
@@ -695,7 +695,7 @@ For a detailed description of this payload and the payload for each type of `act
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `members` permission
- {% data variables.product.prodname_github_apps %} with **Members** permission
### Webhook payload object
@@ -721,7 +721,7 @@ Activity related to merge groups in a merge queue. The type of activity is speci
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `merge_queues` permission
- {% data variables.product.prodname_github_apps %} with **Merge queues** permission
### Webhook payload object
@@ -775,7 +775,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with **Pull requests** permission
### Webhook payload object
@@ -798,7 +798,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_apps %} with the `members` permission
- {% data variables.product.prodname_github_apps %} with **Members** permission
### Webhook payload object
@@ -824,7 +824,7 @@ Key | Type | Description
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission
- {% data variables.product.prodname_github_apps %} with **Administration** organization permission
### Webhook payload object
@@ -870,7 +870,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pages` permission
- {% data variables.product.prodname_github_apps %} with **Pages** permission
### Webhook payload object
@@ -921,7 +921,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission
{% ifversion projects-v2 %}
{% note %}
@@ -953,7 +953,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission
{% ifversion projects-v2 %}
{% note %}
@@ -983,7 +983,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission
{% ifversion projects-v2 %}
{% note %}
@@ -1020,7 +1020,7 @@ Activity related to items in a {% data variables.projects.project_v2 %}. {% data
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `organization_projects` permission
- {% data variables.product.prodname_github_apps %} with **Projects** organization permission
### Webhook payload object
@@ -1046,7 +1046,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with **Metadata** permission
### Webhook payload object
@@ -1073,7 +1073,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with **Pull requests** permission
### Webhook payload object
@@ -1098,7 +1098,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with **Pull requests** permission
### Webhook payload object
@@ -1120,7 +1120,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with **Pull requests** permission
### Webhook payload object
@@ -1143,7 +1143,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
- {% data variables.product.prodname_github_apps %} with **Pull requests** permission
### Webhook payload object
@@ -1171,7 +1171,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -1215,7 +1215,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `contents` permission
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -1236,7 +1236,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends
### Availability
- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook.
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload example
@@ -1250,7 +1250,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_apps %} with the `metadata` permission receive all event types except `deleted`
- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted`
### Webhook payload object
@@ -1319,7 +1319,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission
- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission
### Webhook payload object
@@ -1343,7 +1343,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission
- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission
### Webhook payload object
@@ -1366,7 +1366,7 @@ The security advisory dataset also powers the GitHub {% data variables.product.p
### Availability
- {% data variables.product.prodname_github_apps %} with the `security_events` permission
- {% data variables.product.prodname_github_apps %}
### Webhook payload object
@@ -1391,7 +1391,7 @@ Activity related to enabling or disabling code security and analysis features fo
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration
- {% data variables.product.prodname_github_apps %} with **Administration** repository permission
### Webhook payload object
@@ -1464,7 +1464,7 @@ You can only create a sponsorship webhook on {% data variables.product.prodname_
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `statuses` permission
- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission
### Webhook payload object
@@ -1492,7 +1492,7 @@ Key | Type | Description
### Availability
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `members` permission
- {% data variables.product.prodname_github_apps %} with **Members** permission
### Webhook payload object
@@ -1523,7 +1523,7 @@ Key | Type | Description
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `members` permission
- {% data variables.product.prodname_github_apps %} with **Members** permission
### Webhook payload object
@@ -1564,7 +1564,7 @@ The event’s actor is the [user](/rest/reference/users) who starred a repositor
- Repository webhooks
- Organization webhooks
- {% data variables.product.prodname_github_apps %} with the `metadata` permission
- {% data variables.product.prodname_github_apps %} with **Metadata** permission
### Webhook payload object
@@ -1585,7 +1585,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS
### Availability
- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook.
- {% data variables.product.prodname_github_apps %} with **Contents** permission
### Webhook payload object
@@ -1634,7 +1634,7 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o
### Availability
- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions.
- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions
### Webhook payload object