{"meta":{"title":"创建网络钩子","intro":"可以创建 Webhook 来订阅 GitHub 上发生的特定事件。","product":"Webhook","breadcrumbs":[{"href":"/zh/webhooks","title":"Webhook"},{"href":"/zh/webhooks/using-webhooks","title":"使用网络钩子（Webhook）"},{"href":"/zh/webhooks/using-webhooks/creating-webhooks","title":"创建 Webhook"}],"documentType":"article"},"body":"# 创建网络钩子\n\n可以创建 Webhook 来订阅 GitHub 上发生的特定事件。\n\n## 关于创建 Webhook\n\n可以创建 Webhook 来订阅在 存储库、组织、 GitHub Marketplace 帐户、 GitHub Sponsors 帐户、 或 GitHub App 中发生的特定 GitHub 事件。\n\n有关不同类型的 Webhook 的详细信息，请参阅“[Webhook 的类型](/zh/webhooks/types-of-webhooks)”。\n\n有关 Webhook 事件的完整列表，请参阅“[Webhook 事件和有效负载](/zh/webhooks/webhook-events-and-payloads)”。\n\n## 创建存储库 Webhook\n\n可以创建 Webhook 以订阅在特定存储库中发生的事件。 必须是存储库所有者，或在存储库中具有管理员访问权限的人员，才能在该存储库中创建 Webhook。\n\n可以使用 GitHub Web 界面或 REST API 来创建存储库 Webhook。 有关使用 REST API 创建存储库 Webhook 的详细信息，请参阅“[存储库 Webhook 的 REST API 终结点](/zh/rest/webhooks/repos#create-a-repository-webhook)”。\n\n1. 在 GitHub 上，导航到存储库的主页面。\n2. 在仓库名称下，单击 “Settings”\\*\\*\\*\\*。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。\n\n \n3. 在左边栏中，单击 “Webhooks”\\*\\*\\*\\*。\n4. 单击“添加 Webhook” 。\n5. 在“有效负载 URL”下，键入要接收有效负载的 URL。\n6. （可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。\n * **application/json** 直接将 JSON 有效负载作为 POST `POST` 请求的正文传递。\n * **application/x-www-form-urlencoded** 将 JSON 有效负载作为表单参数发送，称为 `payload`。\n7. （可选）在“机密”下，键入用作 `secret` 密钥的字符串。 应选择高熵的随机文本字符串。 可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。 有关详细信息，请参阅“[验证 Webhook 交付](/zh/webhooks/using-webhooks/securing-your-webhooks)”。\n8. 在“你希望通过哪些事件来触发此 Webhook？”下，选择要接收的 Webhook 事件。 应仅订阅需要的 Webhook 事件。\n9. 如果选择\\*\\*\\*\\*“让我选择单个事件”，请选择你希望触发 Webhook 的事件。\n10. 要在添加配置后使 Webhook 处于活动状态，请选择“活动”。\n11. 单击“添加 Webhook” 。\n\n创建新的 Webhook 后，GitHub 将向你发送一个简单的 `ping` 事件，告知你已正确设置 Webhook。 有关详细信息，请参阅“[Webhook 事件和有效负载](/zh/webhooks/webhook-events-and-payloads#ping)”。\n\n## 创建组织 Webhook\n\n可以创建 Webhook 以订阅在特定组织中发生的事件。 必须是组织所有者，才可以在该组织中创建网络钩子。\n\n可以使用 GitHub Web 界面或 REST API 来创建组织 Webhook。 有关使用 REST API 创建组织 Webhook 的详细信息，请参阅“[用于组织 Webhooks 的 REST API 接口节点](/zh/rest/orgs/webhooks#create-an-organization-webhook)”。\n\n1. 在 GitHub 上任意页的右上角，单击个人资料图片。\n2. 单击“你的组织”。\\*\\*\\*\\*\n3. 在组织右侧，单击“设置”。\n 数据reusables.webhooks.sidebar\\_webhooks %}数据reusables.webhooks.add\\_webhook\\_button %}\n4. 在“有效负载 URL”下，键入要接收有效负载的 URL。\n5. （可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。\n * **application/json** 直接将 JSON 有效负载作为 POST `POST` 请求的正文传递。\n * **application/x-www-form-urlencoded** 将 JSON 有效负载作为表单参数发送，称为 `payload`。\n6. （可选）在“机密”下，键入用作 `secret` 密钥的字符串。 应选择高熵的随机文本字符串。 可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。 有关详细信息，请参阅“[验证 Webhook 交付](/zh/webhooks/using-webhooks/securing-your-webhooks)”。\n7. 在“你希望通过哪些事件来触发此 Webhook？”下，选择要接收的 Webhook 类型。 应仅订阅需要的 Webhook 事件。\n8. 如果选择“让我选择单个事件”\\*\\*\\*\\*，请选择将会触发 Webhook 的事件。\n9. 要在添加配置后使 Webhook 处于活动状态，请选择“活动”。\n10. 单击**添加 webhook**。\n\n创建新的 Webhook 后，GitHub 将向你发送一个简单的 `ping` 事件，告知你已正确设置 Webhook。 有关详细信息，请参阅“[Webhook 事件和有效负载](/zh/webhooks/webhook-events-and-payloads#ping)”。\n\n## 创建GitHub Marketplace webhook\n\n可以创建一个 Webhook 来订阅与在 GitHub Marketplace 中发布的应用相关的事件。 只有应用的所有者或该应用的应用管理员可以创建 GitHub Marketplace Webhook。\n\n1. 导航到“GitHub Marketplace 列表页”。[](https://github.com/marketplace/manage)\n2. 在您想要查看 Webhook 交付情况的 GitHub Marketplace 列表旁边，单击 **管理列表**。\n3. 单击边栏中的“Webhook”。\\*\\*\\*\\*\n4. 在“有效负载 URL”下，键入要接收有效负载的 URL。\n5. （可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。\n * **application/json** 直接将 JSON 有效负载作为 POST `POST` 请求的正文传递。\n * **application/x-www-form-urlencoded** 将 JSON 有效负载作为表单参数发送，称为 `payload`。\n6. （可选）在“机密”下，键入用作 `secret` 密钥的字符串。 应选择高熵的随机文本字符串。 可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。 有关详细信息，请参阅“[验证 Webhook 交付](/zh/webhooks/using-webhooks/securing-your-webhooks)”。\n7. 要在添加配置后使 Webhook 处于活动状态，请选择“活动”。\n8. 单击**创建 Webhook**。\n\n创建新的 Webhook 后，GitHub 将向你发送一个简单的 `ping` 事件，告知你已正确设置 Webhook。 有关详细信息，请参阅“[Webhook 事件和有效负载](/zh/webhooks/webhook-events-and-payloads#ping)”。\n\n## 创建 GitHub Sponsors webhook\n\n可以创建 Webhook 来订阅与赞助相关的事件。 只有被赞助帐户的所有者才能为该帐户创建赞助 Webhook。 有关订阅赞助 Webhook 的事件的详细信息，请参阅 [`sponsorship` Webhook 事件](/zh/webhooks-and-events/webhooks/webhook-events-and-payloads#sponsorship)。\n\n1. 在任何页面的右上角，单击个人资料照片，然后单击你的赞助者\\*\\*\\*\\*。\n2. 在要为其创建 Webhook 的帐户旁边，单击“控制面板”\\*\\*\\*\\*。\n3. 在左侧边栏中，单击“Webhook”。\n4. 单击“添加 Webhook” 。\n5. 在“有效负载 URL”下，键入要接收有效负载的 URL。\n6. （可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。\n * **application/json** 直接将 JSON 有效负载作为 POST `POST` 请求的正文传递。\n * **application/x-www-form-urlencoded** 将 JSON 有效负载作为表单参数发送，称为 `payload`。\n7. （可选）在“机密”下，键入用作 `secret` 密钥的字符串。 应选择高熵的随机文本字符串。 可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。 有关详细信息，请参阅“[验证 Webhook 交付](/zh/webhooks/using-webhooks/securing-your-webhooks)”。\n8. 要在添加配置后使 Webhook 处于活动状态，请选择“活动”。\n9. 单击**创建 Webhook**。\n\n## 为 GitHub App 创建 Webhook。\n\nGitHub App 的所有者可以为应用订阅 Webhook 事件，以便在发生特定事件时收到通知。 如果应用所有者为 GitHub App 指定了任何应用管理员，则应用管理员也可以为应用订阅 Webhook 事件。 有关详细信息，请参阅“[将 Webhook 与 GitHub 应用配合使用](/zh/apps/creating-github-apps/creating-github-apps/using-webhooks-with-github-apps)”。\n\n每个 GitHub App 有一个 Webhook。 可以在注册 GitHub App 时配置 Webhook，也可以编辑现有 GitHub App 注册的 Webhook 配置。\n\n有关注册 GitHub App 时配置 Webhook 的详细信息，请参阅“[注册GitHub应用](/zh/apps/creating-github-apps/registering-a-github-app/registering-a-github-app)”。\n\n要为现有 GitHub App 注册配置 Webhook：\n\n1. 在 GitHub 上任意页的右上角，单击你的个人资料图片。\n2. 导航到你的帐户设置。\n * 对于由个人帐户拥有的应用，请单击“设置”\\*\\*\\*\\*。\n * 对于组织拥有的应用：\n 1. 单击“你的组织”。\n 2. 在组织的右侧，单击**设置**。\n3. 在左边栏中，单击 “Developer settings”\\*\\*\\*\\*。\n4. 在左侧边栏中，单击“GitHub Apps”。\n5. 在要为其配置 Webhook 的 GitHub App 旁边，单击“编辑”\\*\\*\\*\\*。\n6. 在“Webhook”下，选择“启用”\\*\\*\\*\\*。\n7. 在“Webhook URL”下，输入你希望接收数据的 URL。\n8. （可选）在“Webhook 机密”下，键入用作 `secret` 密钥的字符串。 应选择高熵的随机文本字符串。 可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。 有关详细信息，请参阅“[验证 Webhook 交付](/zh/webhooks/using-webhooks/securing-your-webhooks)”。\n9. 单击“保存更改”。\n10. 在边栏中，单击“权限和事件”\\*\\*\\*\\*。\n11. 可以为 GitHub App 注册选择的具体 Webhook 事件根据为应用选择的权限类型而定。 首先需要选择希望应用拥有的权限，然后可以让应用订阅与该权限集相关的 Webhook 事件。\n\n 在“存储库权限”、“组织权限”和“帐户权限”部分下，选择应用将订阅的事件所需的权限。 有关详细信息，请参阅“[为GitHub应用选择权限](/zh/apps/creating-github-apps/creating-github-apps/choosing-permissions-for-a-github-app)”。 有关更改权限时需考虑事项的详细信息，请参阅[修改 GitHub App 注册](/zh/apps/maintaining-github-apps/modifying-a-github-app-registration#changing-the-permissions-of-a-github-app)。\n12. 在“订阅事件”下，选择希望 GitHub App 接收的 Webhook 事件。\n13. 单击“保存更改”。\n\n可以使用 REST API 为 GitHub App 创建 Webhook。 有关详细信息，请参阅“[Webhooks 的 GitHub App REST API 终结点](/zh/rest/apps/webhooks)”。\n\n## 其他阅读材料\n\n* [关于 网络钩子](/zh/webhooks/about-webhooks)\n* [处理 Webhook 交付](/zh/webhooks/using-webhooks/handling-webhook-deliveries)"}