From 4c8ec73cb9eab83e685a0416e4986958ba8d9823 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Wed, 30 Aug 2023 10:49:37 -0700 Subject: [PATCH] Add article about viewing webhook deliveries (#41364) Co-authored-by: Rachael Sewell --- .../managing-global-webhooks.md | 10 +- .../index.md | 1 + .../viewing-webhook-deliveries.md | 93 +++++++++++++++++++ .../webhooks/webhook_recent_deliveries.md | 5 + .../webhooks/webhook_recent_deliveries_tab.md | 2 + data/reusables/webhooks/webhook_url_list.md | 3 + 6 files changed, 105 insertions(+), 9 deletions(-) create mode 100644 content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md create mode 100644 data/reusables/webhooks/webhook_recent_deliveries.md create mode 100644 data/reusables/webhooks/webhook_recent_deliveries_tab.md create mode 100644 data/reusables/webhooks/webhook_url_list.md diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks.md index 1f37ad8137..a07c124ba8 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity-in-your-enterprise/managing-global-webhooks.md @@ -78,12 +78,4 @@ For example, you can configure {% data variables.location.product_location %} to ## Viewing recent deliveries and responses -{% data reusables.enterprise-accounts.access-enterprise %} -{% data reusables.enterprise-accounts.settings-tab %} -{% data reusables.enterprise-accounts.hooks-tab %} -1. In the list of webhooks, click the URL of the webhook for which you'd like to see deliveries. - - ![Screenshot of a list of global webhooks. The URL link to view a webhook is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/click-global-webhook.png) -1. Under "Recent deliveries", click a delivery GUID to view details. - - ![Screenshot of the "Recent deliveries" list for a global webhook. A delivery GUID in the list of deliveries is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/global-webhooks-recent-deliveries.png) +You can view details about webhook deliveries that occurred in the past 30 days. For more information, see "[AUTOTITLE](/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries)." diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/index.md b/content/webhooks/testing-and-troubleshooting-webhooks/index.md index 26126c6b1b..b38c4b9c43 100644 --- a/content/webhooks/testing-and-troubleshooting-webhooks/index.md +++ b/content/webhooks/testing-and-troubleshooting-webhooks/index.md @@ -9,6 +9,7 @@ versions: topics: - Webhooks children: + - /viewing-webhook-deliveries - /testing-webhooks - /receiving-webhooks-with-the-github-cli --- diff --git a/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md new file mode 100644 index 0000000000..90a3330038 --- /dev/null +++ b/content/webhooks/testing-and-troubleshooting-webhooks/viewing-webhook-deliveries.md @@ -0,0 +1,93 @@ +--- +title: Viewing webhook deliveries +intro: 'You can view details about webhook deliveries from the past 30 days.' +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +topics: + - Webhooks +--- + +## About webhook deliveries + +You can view details about webhook deliveries that occurred in the past 30 days. Viewing past deliveries can help you verify whether your webhooks are working as expected. + +For each webhook delivery, you can view: + +- the request headers and payload that {% data variables.product.company_short %} sent +- the time at which the request was sent +- the response that {% data variables.product.company_short %} received from your server + +## Viewing deliveries for repository webhooks + +Only people with admin access to a repository can view deliveries for webhooks in that repository. + +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)." + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.repositories.sidebar-settings %} +1. In the "Code and automation" section of the sidebar, click **{% octicon "webhook" aria-hidden="true" %} Webhooks**. +{% data reusables.webhooks.webhook_url_list %} +{% data reusables.webhooks.webhook_recent_deliveries_tab %} + +## Viewing deliveries for organization webhooks + +Only organization owners can view deliveries for webhooks in that organization. + +You can use the {% data variables.product.company_short %} web interface or the REST API to view recent webhook deliveries for an organization. For more information about using the REST API to view recent deliveries, see "[AUTOTITLE](/rest/orgs/webhooks)." + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +1. In the "Code and automation" section of the sidebar, click **{% octicon "webhook" aria-hidden="true" %} Webhooks**. +{% data reusables.webhooks.webhook_url_list %} +{% data reusables.webhooks.webhook_recent_deliveries_tab %} + +## Viewing deliveries for {% data variables.product.prodname_github_app %} webhooks + +The owner of a {% data variables.product.prodname_github_app %} can view recent webhook deliveries for the app. If an organization has designated any app managers for a {% data variables.product.prodname_github_app %} owned by the organization, the app managers can also view recent webhook deliveries. + +You can use the {% data variables.product.company_short %} web interface or the REST API to view recent webhook deliveries for a {% data variables.product.prodname_github_app %}. For more information about using the REST API to view recent deliveries, see "[AUTOTITLE](/rest/apps/webhooks)." + +{% data reusables.apps.settings-step %} +{% data reusables.user-settings.developer_settings %} +{% data reusables.user-settings.github_apps %} +1. Next to the {% data variables.product.prodname_github_app %} that you want to view webhook deliveries for, click **Edit**. +1. In the sidebar, click **Advanced**. +{% data reusables.webhooks.webhook_recent_deliveries %} + +## Viewing deliveries for {% data variables.product.prodname_marketplace %} webhooks + +The owner of a {% data variables.product.prodname_github_app %} can view recent {% data variables.product.prodname_marketplace %} webhook deliveries for the app. If an organization has designated any app managers for a {% data variables.product.prodname_github_app %} owned by the organization, the app managers can also view recent webhook deliveries. + +1. Navigate to your [{% data variables.product.prodname_marketplace %} listing page](https://github.com/marketplace/manage). +1. Next to the {% data variables.product.prodname_marketplace %} listing that you want to view webhook deliveries for, click **Manage listing**. +1. In the sidebar, click **Webhook**. +{% data reusables.webhooks.webhook_recent_deliveries %} + +## Viewing deliveries for {% data variables.product.prodname_sponsors %} webhooks + +Only the owner of the sponsored account can view deliveries for sponsorship webhooks for that account. + +1. In the upper-right corner of any page, click your profile photo, then click **Your sponsors**. +1. Next to the account you want to view webhook deliveries for, click **Dashboard**. +1. In the sidebar, click **Webhooks**. +{% data reusables.webhooks.webhook_url_list %} +{% data reusables.webhooks.webhook_recent_deliveries %} + +{% ifversion ghes or ghae or ghec %} + +## Viewing deliveries for global webhooks + +Only enterprise owners can view deliveries for webhooks in that enterprise. + +{% ifversion ghes or ghae %}You can use the {% data variables.product.company_short %} web interface or the REST API to view recent deliveries for global webhooks. For more information about using the REST API to view recent deliveries, see "[AUTOTITLE](/rest/enterprise-admin/global-webhooks)."{% endif %} + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.hooks-tab %} +{% data reusables.webhooks.webhook_url_list %} +{% data reusables.webhooks.webhook_recent_deliveries %} + +{% endif %} diff --git a/data/reusables/webhooks/webhook_recent_deliveries.md b/data/reusables/webhooks/webhook_recent_deliveries.md new file mode 100644 index 0000000000..1267cbad03 --- /dev/null +++ b/data/reusables/webhooks/webhook_recent_deliveries.md @@ -0,0 +1,5 @@ +1. Under "Recent deliveries", all deliveries from the past 30 days will be listed. If this webhook has not been delivered within the past 30 days, no deliveries will be listed. If webhooks are not active, the "Recent Deliveries" section will not be present. + + Click a delivery GUID to view details. + + ![Screenshot of the "Recent deliveries" list for a webhook. A delivery GUID in the list of deliveries is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/global-webhooks-recent-deliveries.png) diff --git a/data/reusables/webhooks/webhook_recent_deliveries_tab.md b/data/reusables/webhooks/webhook_recent_deliveries_tab.md new file mode 100644 index 0000000000..d601888fb6 --- /dev/null +++ b/data/reusables/webhooks/webhook_recent_deliveries_tab.md @@ -0,0 +1,2 @@ +1. Click **Recent deliveries**. All deliveries from the past 30 days will be listed. If this webhook has not been delivered within the past 30 days, no deliveries will be listed. +1. Click a delivery GUID to view details. diff --git a/data/reusables/webhooks/webhook_url_list.md b/data/reusables/webhooks/webhook_url_list.md new file mode 100644 index 0000000000..2202dbb986 --- /dev/null +++ b/data/reusables/webhooks/webhook_url_list.md @@ -0,0 +1,3 @@ +1. In the list of webhooks, click the URL of the webhook for which you'd like to see deliveries. If you do not have a webhook configured, no webhooks will be listed. + + ![Screenshot of a list of webhooks. The URL link to view a webhook is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/click-global-webhook.png) \ No newline at end of file