Skip to content

Commit 4444204

Browse files
heiskrCopilot
andauthored
Update redirected internal links in webhooks (#62113)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 4250a7b commit 4444204

17 files changed

Lines changed: 33 additions & 33 deletions

content/webhooks/about-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For example, you could subscribe your webhook to events that occur when code is
4444

4545
You must create a webhook within a specific repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %}. The webhook can only access resources that are available in the repository, organization, {% ifversion ghes or ghec %}{% data variables.product.prodname_enterprise %}, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_marketplace %} account, {% endif %} {% ifversion fpt or ghec %}{% data variables.product.prodname_sponsors %} account, {% endif %} or {% data variables.product.prodname_github_app %} where it is installed. For more information, see [AUTOTITLE](/webhooks/types-of-webhooks).
4646

47-
For more information about creating webhooks, see [AUTOTITLE](/webhooks/using-webhooks/creating-webhooks). For more information about the types of events you can subscribe to, see [AUTOTITLE](/webhooks/webhook-events-and-payloads). For more information about configuring your server to take an action in response to a payload delivery, see [AUTOTITLE](/webhooks/using-webhooks/configuring-your-server-to-receive-payloads).
47+
For more information about creating webhooks, see [AUTOTITLE](/webhooks/using-webhooks/creating-webhooks). For more information about the types of events you can subscribe to, see [AUTOTITLE](/webhooks/webhook-events-and-payloads). For more information about configuring your server to take an action in response to a payload delivery, see [AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries).
4848

4949
{% data reusables.webhooks.webhooks-ipv6 %}
5050

content/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You may want to redeliver a webhook to help you test your application or to reco
1818

1919
Only people with admin access to a repository can redeliver webhooks in that repository.
2020

21-
You can use the {% data variables.product.company_short %} web interface or the REST API to redeliver webhooks for a repository. For more information about using the REST API to redeliver webhooks, see [AUTOTITLE](/rest/webhooks/repo-deliveries).
21+
You can use the {% data variables.product.company_short %} web interface or the REST API to redeliver webhooks for a repository. For more information about using the REST API to redeliver webhooks, see [AUTOTITLE](/rest/repos/webhooks).
2222

2323
{% data reusables.repositories.navigate-to-repo %}
2424
{% data reusables.repositories.sidebar-settings %}

content/webhooks/testing-and-troubleshooting-webhooks/testing-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ You can trigger a webhook event and verify that {% data variables.product.compan
3232

3333
You can also redeliver a previous webhook delivery. For more information, see [AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/redelivering-webhooks).
3434

35-
If you are using an organization or repository webhook, you can also use the REST API to trigger the `ping` event for your webhook. If you are using a repository webhook and your webhook is subscribed to the `push` event, you can use the REST API to trigger a test `push` event for your webhook. For more information, see [AUTOTITLE](/rest/webhooks/repos) and [AUTOTITLE](/rest/orgs/webhooks).
35+
If you are using an organization or repository webhook, you can also use the REST API to trigger the `ping` event for your webhook. If you are using a repository webhook and your webhook is subscribed to the `push` event, you can use the REST API to trigger a test `push` event for your webhook. For more information, see [AUTOTITLE](/rest/repos/webhooks) and [AUTOTITLE](/rest/orgs/webhooks).
3636

3737
1. Check {% data variables.product.company_short %} to verify that a webhook delivery was sent. For information about how to do this for each webhook type, see [AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries).
3838

content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You can also redeliver recent webhook deliveries. For more information, see [AUT
2626

2727
Only people with admin access to a repository can view deliveries for webhooks in that repository.
2828

29-
You can use the {% data variables.product.company_short %} web interface or the REST API to view recent webhook deliveries for a repository. For more information about using the REST API to view recent deliveries, see [AUTOTITLE](/rest/webhooks/repo-deliveries).
29+
You can use the {% data variables.product.company_short %} web interface or the REST API to view recent webhook deliveries for a repository. For more information about using the REST API to view recent deliveries, see [AUTOTITLE](/rest/repos/webhooks).
3030

3131
{% data reusables.repositories.navigate-to-repo %}
3232
{% data reusables.repositories.sidebar-settings %}

content/webhooks/types-of-webhooks.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ You can create webhooks in a repository to subscribe to events that occur in tha
3131

3232
You can create multiple webhooks in a single repository. However, you can only create up to {% ifversion ghes %}250{% else %}20{% endif %} webhooks that subscribe to each individual event type. For example, in a single repository you could only create up to {% ifversion ghes %}250{% else %}20{% endif %} different webhooks that each subscribe to the `push` event.
3333

34-
You can use the {% data variables.product.github %} web interface or the REST API to manage repository webhooks. For more information, see [AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-a-repository-webhook), [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-a-repository-webhook), and [AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-a-repository-webhook). For more information about using the REST API to manage repository webhooks, see [AUTOTITLE](/rest/webhooks).
34+
You can use the {% data variables.product.github %} web interface or the REST API to manage repository webhooks. For more information, see [AUTOTITLE](/webhooks/using-webhooks/creating-webhooks#creating-a-repository-webhook), [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks#editing-a-repository-webhook), and [AUTOTITLE](/webhooks/using-webhooks/disabling-webhooks#disabling-a-repository-webhook). For more information about using the REST API to manage repository webhooks, see [AUTOTITLE](/rest/repos/webhooks).
3535

3636
## Organization webhooks
3737

content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-github-app-webhook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The endpoints to find and redeliver failed webhooks require a JSON web token, wh
3232
The endpoints to fetch and update the value of environment variables require a {% data variables.product.pat_generic %}, {% data variables.product.prodname_github_app %} installation access token, or {% data variables.product.prodname_github_app %} user access token. This example uses a {% data variables.product.pat_generic %}. If your {% data variables.product.prodname_github_app %} is installed on the repository where this workflow will run and has permission to write repository variables, you can modify this example to create an installation access token during the {% data variables.product.prodname_actions %} workflow instead of using a {% data variables.product.pat_generic %}. For more information, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/making-authenticated-api-requests-with-a-github-app-in-a-github-actions-workflow).
3333

3434
1. Find the app ID for your {% data variables.product.prodname_github_app %}. You can find the app ID on the settings page for your app. The app ID is different from the client ID. For more information about navigating to the settings page for your {% data variables.product.prodname_github_app %}, see [AUTOTITLE](/apps/maintaining-github-apps/modifying-a-github-app-registration#navigating-to-your-github-app-settings).
35-
1. Store the app ID from the previous step as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information about storing secrets, see [AUTOTITLE](/actions/security-guides/encrypted-secrets).
35+
1. Store the app ID from the previous step as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information about storing secrets, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
3636
1. Generate a private key for your app. For more information about generating a private key, see [AUTOTITLE](/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps).
3737
1. Store the private key, including `-----BEGIN RSA PRIVATE KEY-----` and `-----END RSA PRIVATE KEY-----`, from the previous step as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run.
3838
1. Create a {% data variables.product.pat_generic %} with the following access. For more information, see [AUTOTITLE](/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens).
@@ -329,7 +329,7 @@ async function updateVariable({
329329

330330
## Testing the script
331331

332-
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/using-workflows/manually-running-a-workflow) and [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs).
332+
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/manually-run-a-workflow) and [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs).
333333

334334
## Alternative methods
335335

content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-a-repository-webhook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The built in `GITHUB_TOKEN` does not have sufficient permissions to redeliver we
3636
* Write access to the repository webhooks permission
3737
* Write access to the repository variables permission
3838
* For a {% data variables.product.pat_v1 %}, grant the token the `repo` scope.
39-
1. Store your {% data variables.product.pat_generic %} as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets).
39+
1. Store your {% data variables.product.pat_generic %} as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
4040

4141
## Adding a workflow that will run the script
4242

@@ -347,7 +347,7 @@ async function updateVariable({
347347

348348
## Testing the script
349349

350-
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/using-workflows/manually-running-a-workflow) and [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs).
350+
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/manually-run-a-workflow) and [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs).
351351

352352
## Alternative methods
353353

content/webhooks/using-webhooks/automatically-redelivering-failed-deliveries-for-an-organization-webhook.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The built in `GITHUB_TOKEN` does not have sufficient permissions to redeliver we
3636
* Grant the token write access to the organization webhooks permission
3737
* Grant the token write access to the repository variables permission
3838
* For a {% data variables.product.pat_v1 %}, grant the token the `admin:org_hook` and `repo` scope.
39-
1. Store your {% data variables.product.pat_generic %} as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information, see [AUTOTITLE](/actions/security-guides/encrypted-secrets).
39+
1. Store your {% data variables.product.pat_generic %} as a {% data variables.product.prodname_actions %} secret in the repository where you want the workflow to run. For more information, see [AUTOTITLE](/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets).
4040

4141
## Adding a workflow that will run the script
4242

@@ -338,7 +338,7 @@ async function updateVariable({
338338

339339
## Testing the script
340340

341-
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/using-workflows/manually-running-a-workflow) and [AUTOTITLE](/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs).
341+
You can manually trigger your workflow to test the script. For more information, see [AUTOTITLE](/actions/how-tos/manage-workflow-runs/manually-run-a-workflow) and [AUTOTITLE](/actions/how-tos/monitor-workflows/use-workflow-run-logs).
342342

343343
## Alternative methods
344344

content/webhooks/using-webhooks/best-practices-for-using-webhooks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ category:
1212

1313
## Subscribe to the minimum number of events
1414

15-
You should only subscribe to the webhook events that you need. This will reduce the amount of work your server needs to do. For more information about subscribing to events, see [AUTOTITLE](/webhooks/creating-webhooks) and [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks).
15+
You should only subscribe to the webhook events that you need. This will reduce the amount of work your server needs to do. For more information about subscribing to events, see [AUTOTITLE](/webhooks/using-webhooks/creating-webhooks) and [AUTOTITLE](/webhooks/using-webhooks/editing-webhooks).
1616

1717
## Use a webhook secret
1818

@@ -61,5 +61,5 @@ In a replay attack, a bad actor intercepts a webhook delivery and re-sends the d
6161
6262
## Further reading
6363

64-
* [AUTOTITLE](/rest/guides/best-practices-for-integrators)
64+
* [AUTOTITLE](/rest/using-the-rest-api/best-practices-for-using-the-rest-api)
6565
* [AUTOTITLE](/apps/creating-github-apps/about-creating-github-apps/best-practices-for-creating-a-github-app)

content/webhooks/using-webhooks/creating-webhooks.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ For a complete list of webhook events, see [AUTOTITLE](/webhooks/webhook-events-
2929

3030
You can create a webhook to subscribe to events that occur in a specific repository. You must be a repository owner or have admin access in the repository to create webhooks in that repository.
3131

32-
You can use the {% data variables.product.github %} web interface or the REST API to create a repository webhook. For more information about using the REST API to create a repository webhook, see [AUTOTITLE](/rest/webhooks/repos#create-a-repository-webhook).
32+
You can use the {% data variables.product.github %} web interface or the REST API to create a repository webhook. For more information about using the REST API to create a repository webhook, see [AUTOTITLE](/rest/repos/webhooks#create-a-repository-webhook).
3333

3434
{% data reusables.repositories.navigate-to-repo %}
3535
{% data reusables.repositories.sidebar-settings %}
@@ -112,7 +112,7 @@ After you create a new webhook, {% data variables.product.github %} will send yo
112112

113113
## Creating a {% data variables.product.prodname_sponsors %} webhook
114114

115-
You can create a webhook to subscribe to events relating to your sponsorships. Only the owner of the sponsored account can create sponsorship webhooks for that account. For more information about the event that a sponsorship webhook is subscribed to, see the [`sponsorship` webhook event](/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship).
115+
You can create a webhook to subscribe to events relating to your sponsorships. Only the owner of the sponsored account can create sponsorship webhooks for that account. For more information about the event that a sponsorship webhook is subscribed to, see the [`sponsorship` webhook event](/webhooks/webhook-events-and-payloads#sponsorship).
116116

117117
1. In the upper-right corner of any page, click your profile picture, then click **Your sponsors**.
118118
1. Next to the account you want to create a webhook for, click **Dashboard**.
@@ -127,7 +127,7 @@ You can create a webhook to subscribe to events relating to your sponsorships. O
127127

128128
## Creating webhooks for a {% data variables.product.prodname_github_app %}
129129

130-
The owner of a {% data variables.product.prodname_github_app %} can subscribe the app to webhook events to receive notifications whenever certain events occur. If the app owner has designated any app managers for a {% data variables.product.prodname_github_app %}, the app managers can also subscribe the app to webhook events. For more information, see [AUTOTITLE](/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps).
130+
The owner of a {% data variables.product.prodname_github_app %} can subscribe the app to webhook events to receive notifications whenever certain events occur. If the app owner has designated any app managers for a {% data variables.product.prodname_github_app %}, the app managers can also subscribe the app to webhook events. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps).
131131

132132
Each {% data variables.product.prodname_github_app %} has one webhook. You can configure the webhook when you register a {% data variables.product.prodname_github_app %}, or you can edit the webhook configuration for an existing {% data variables.product.prodname_github_app %} registration.
133133

@@ -140,12 +140,12 @@ To configure a webhook for an existing {% data variables.product.prodname_github
140140
1. Next to the {% data variables.product.prodname_github_app %} that you want to configure the webhook for, click **Edit**.
141141
1. Under "Webhook," select **Active**.
142142
1. Under "Webhook URL", type the URL where you'd like to receive payloads.
143-
1. Optionally, under "Webhook secret", type a string to use as a `secret` key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from {% data variables.product.github %}. For more information, see [AUTOTITLE](/webhooks/using-webhooks/securing-your-webhooks).
143+
1. Optionally, under "Webhook secret", type a string to use as a `secret` key. You should choose a random string of text with high entropy. You can use the webhook secret to limit incoming requests to only those originating from {% data variables.product.github %}. For more information, see [AUTOTITLE](/webhooks/using-webhooks/validating-webhook-deliveries).
144144
1. Click **Save changes**.
145145
1. In the sidebar, click **Permissions & events**.
146146
1. {% data reusables.apps.webhooks-and-apps %}
147147

148-
Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. For more information, see [AUTOTITLE](/apps/creating-github-apps/creating-github-apps/choosing-permissions-for-a-github-app). For more information about things to consider when changing the permissions, see [Modifying a {% data variables.product.prodname_github_app %} registration](/apps/maintaining-github-apps/modifying-a-github-app-registration#changing-the-permissions-of-a-github-app).
148+
Under the sections "Repository permissions," "Organization permissions," and "Account permissions," select the permissions that are required for the events your app will subscribe to. For more information, see [AUTOTITLE](/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app). For more information about things to consider when changing the permissions, see [Modifying a {% data variables.product.prodname_github_app %} registration](/apps/maintaining-github-apps/modifying-a-github-app-registration#changing-the-permissions-of-a-github-app).
149149
1. Under "Subscribe to Events," select the webhook events you would like your {% data variables.product.prodname_github_app %} to receive.
150150
1. Click **Save changes**.
151151

0 commit comments

Comments
 (0)