From 3b1ee08abd4cefa497b93ae51253f182d806af4c Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Wed, 1 Feb 2023 12:44:00 -0800 Subject: [PATCH] Note that webhooks do not support IPv6 (#34271) Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com> --- .../webhooks-and-events/webhooks/about-webhooks.md | 3 +++ .../webhooks-and-events/webhooks/creating-webhooks.md | 2 ++ data/reusables/webhooks/webhooks-ipv6.md | 5 +++++ 3 files changed, 10 insertions(+) create mode 100644 data/reusables/webhooks/webhooks-ipv6.md diff --git a/content/developers/webhooks-and-events/webhooks/about-webhooks.md b/content/developers/webhooks-and-events/webhooks/about-webhooks.md index c5fbc4d8c7..010113e7c6 100644 --- a/content/developers/webhooks-and-events/webhooks/about-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/about-webhooks.md @@ -12,6 +12,9 @@ versions: topics: - Webhooks --- + +{% data reusables.webhooks.webhooks-ipv6 %} + 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. diff --git a/content/developers/webhooks-and-events/webhooks/creating-webhooks.md b/content/developers/webhooks-and-events/webhooks/creating-webhooks.md index 2cd4341037..deecd90d61 100644 --- a/content/developers/webhooks-and-events/webhooks/creating-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/creating-webhooks.md @@ -55,6 +55,8 @@ Webhooks require a few configuration options before you can make use of them. We ## Payload URL +{% data reusables.webhooks.webhooks-ipv6 %} + {% data reusables.webhooks.payload_url %} Since we're developing locally for our tutorial, we'll set it to the `*.ngrok.io` URL, followed by `/payload`. For example, `http://7e9ea9dc.ngrok.io/payload`. diff --git a/data/reusables/webhooks/webhooks-ipv6.md b/data/reusables/webhooks/webhooks-ipv6.md new file mode 100644 index 0000000000..f77c6e658b --- /dev/null +++ b/data/reusables/webhooks/webhooks-ipv6.md @@ -0,0 +1,5 @@ +{% note %} + +**Note**: {% data variables.product.company_short %} webhooks do not currently support IPv6 but will in the future. The `/meta` REST API endpoint returns IPv6 ranges to enable that transition. + +{% endnote %}