创建 Webhooks

您可以创建 Webhooks 来订阅在 GitHub 上发生的特定事件。

本文内容

关于创建 Webhooks

您可以创建 Webhooks 来订阅在 GitHub 上发生并位于仓库、组织、GitHub Marketplace 账户、GitHub Sponsors 账户或 GitHub 应用中的特定事件。

有关不同类型 Webhook 的更多信息，请参阅 Webhook 类型。

有关完整的 Webhook 事件列表，请参阅 Webhook 事件与负载。

创建仓库 Webhook

您可以创建 Webhook 以订阅在特定仓库中发生的事件。要在该仓库中创建 Webhook，您必须是仓库所有者或具有管理员权限。

您可以使用 GitHub 网页界面或 REST API 来创建仓库 Webhook。有关使用 REST API 创建仓库 Webhook 的更多信息，请参阅 仓库 Webhook 的 REST API 端点。

  1. 在 GitHub 上，导航至仓库的主页面。

  2. 在仓库名称下，点击 设置。如果您看不到 “设置” 选项卡，请选择 下拉菜单，然后点击 设置。

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

  3. 在左侧边栏，点击 Webhook。

  4. 点击 添加 webhook。

  5. 在 “Payload URL” 下，输入您希望接收负载的 URL。

  6. （可选）选择 Content type 下拉菜单，然后点击您想要接收 Webhook 负载的数据格式。

    • application/json 将直接把 JSON 负载作为 POST 请求的主体返回。
    • application/x-www-form-urlencoded 会把 JSON 负载作为名为 payload 的表单参数发送。

  7. （可选）在 “Secret” 下，输入一个字符串作为 secret 密钥。请使用高熵的随机字符串。您可以使用 Webhook secret 来限制仅接受来自 GitHub 的请求。有关详细信息，请参阅 验证 Webhook 投递。

  8. 在 “Which events would you like to trigger this webhook?”（您希望哪些事件触发此 Webhook？）下，选择您想接收的 Webhook 事件。请仅订阅您需要的事件。

  9. 如果您选择了 Let me select individual events（让我选择单独的事件），请勾选您希望触发 Webhook 的事件。

  10. 若要在添加配置后立即激活 Webhook，请选中 Active。

  11. 点击 添加 webhook。

创建新的 Webhook 后，GitHub 会发送一个简单的 ping 事件，以告知您已正确设置 Webhook。有关详细信息，请参阅 Webhook 事件与负载。

创建组织 Webhook

您可以创建 Webhook 以订阅在特定组织中发生的事件。要在该组织中创建 Webhook，您必须是组织所有者。

您可以使用 GitHub 网页界面或 REST API 来创建组织 Webhook。有关使用 REST API 创建组织 Webhook 的更多信息，请参阅 组织 Webhook 的 REST API 端点。

  1. 在 GitHub 任意页面的右上角，点击您的个人资料图片。
  2. 点击 您的组织。
  3. 在组织右侧，点击 设置。
  4. 在左侧边栏，点击 Webhook。
  5. 点击 添加 webhook。
  6. 在 “Payload URL” 下，输入您希望接收负载的 URL。
  7. （可选）选择 Content type 下拉菜单，然后点击您想要接收 Webhook 负载的数据格式。
    • application/json 将直接把 JSON 负载作为 POST 请求的主体返回。
    • application/x-www-form-urlencoded 会把 JSON 负载作为名为 payload 的表单参数发送。
  8. （可选）在 “Secret” 下，输入一个字符串作为 secret 密钥。请使用高熵的随机字符串。您可以使用 Webhook secret 来限制仅接受来自 GitHub 的请求。有关详细信息，请参阅 验证 Webhook 投递。
  9. 在 “Which events would you like to trigger this webhook?”（您希望哪些事件触发此 Webhook？）下，选择您想接收的 Webhook 类型。请仅订阅您需要的事件。
  10. 如果您选择了 Let me select individual events（让我选择单独的事件），请勾选将触发 Webhook 的事件。
  11. 若要在添加配置后立即激活 Webhook，请选中 Active。
  12. 点击 添加 webhook。

创建新的 Webhook 后，GitHub 会发送一个简单的 ping 事件，以告知您已正确设置 Webhook。有关详细信息，请参阅 Webhook 事件与负载。

创建 GitHub Marketplace Webhook

您可以创建 Webhook 以订阅与您在 GitHub Marketplace 上发布的应用相关的事件。仅应用所有者或该应用的应用管理员可以创建 GitHub Marketplace Webhook。

  1. 前往您的 GitHub Marketplace 列表页面。
  2. 在您想查看 webhook 发送记录的 GitHub Marketplace 列表旁，点击 管理列表。
  3. 在侧栏，点击 Webhook。
  4. 在 “Payload URL” 下，输入您希望接收负载的 URL。
  5. （可选）选择 Content type 下拉菜单，然后点击您想要接收 Webhook 负载的数据格式。
    • application/json 将直接把 JSON 负载作为 POST 请求的主体返回。
    • application/x-www-form-urlencoded 会把 JSON 负载作为名为 payload 的表单参数发送。
  6. （可选）在 “Secret” 下，输入一个字符串作为 secret 密钥。请使用高熵的随机字符串。您可以使用 Webhook secret 来限制仅接受来自 GitHub 的请求。有关详细信息，请参阅 验证 Webhook 投递。
  7. 若要在添加配置后立即激活 Webhook，请选中 Active。
  8. 点击 创建 webhook。

创建新的 Webhook 后，GitHub 会发送一个简单的 ping 事件，以告知您已正确设置 Webhook。有关详细信息，请参阅 Webhook 事件与负载。

创建 GitHub Sponsors Webhook

您可以创建 Webhook 以订阅与您的赞助相关的事件。只有受赞助账户的所有者才能为该账户创建赞助 Webhook。有关赞助 Webhook 所订阅的事件的详细信息，请参阅 sponsorship webhook 事件。

  1. 在任何页面的右上角，点击您的个人资料图片，然后点击 您的赞助者。
  2. 在您想为其创建 Webhook 的账户旁边，点击 仪表板。
  3. 在左侧边栏，点击 Webhook。
  4. 点击 添加 webhook。
  5. 在 “Payload URL” 下，输入您希望接收负载的 URL。
  6. （可选）选择 Content type 下拉菜单，然后点击您想要接收 Webhook 负载的数据格式。
    • application/json 将直接把 JSON 负载作为 POST 请求的主体返回。
    • application/x-www-form-urlencoded 会把 JSON 负载作为名为 payload 的表单参数发送。
  7. （可选）在 “Secret” 下，输入一个字符串作为 secret 密钥。请使用高熵的随机字符串。您可以使用 Webhook secret 来限制仅接受来自 GitHub 的请求。有关详细信息，请参阅 验证 Webhook 投递。
  8. 若要在添加配置后立即激活 Webhook，请选中 Active。
  9. 点击 创建 webhook。

为 GitHub 应用创建 Webhook

GitHub 应用的所有者可以为该应用订阅 Webhook 事件，以便在特定事件发生时收到通知。如果应用所有者为 GitHub 应用指定了应用管理员，应用管理员也可以为应用订阅 Webhook 事件。有关详细信息，请参阅 使用 Webhook 与 GitHub 应用。

每个 GitHub 应用只有一个 Webhook。您可以在注册 GitHub 应用时配置该 Webhook，或在已有的 GitHub 应用注册中编辑其 Webhook 配置。

有关在注册 GitHub 应用时配置 Webhook 的更多信息，请参阅 注册 GitHub 应用。

为已有的 GitHub 应用注册配置 Webhook

  1. 在 GitHub 任意页面的右上角，点击您的个人资料图片。

  2. 前往您的账户设置。

    • 对于由个人账户拥有的 App，点击 设置。
    • 对于由组织拥有的 App
      1. 点击 您的组织。
      2. 在组织右侧，点击 设置。

  3. 在左侧边栏，点击 开发者设置。

  4. 在左侧边栏，点击 GitHub Apps。

  5. 在您想为其配置 Webhook 的 GitHub 应用旁边，点击 编辑。

  6. 在 “Webhook” 下，选中 Active。

  7. 在 “Webhook URL” 下，输入您希望接收负载的 URL。

  8. （可选）在 “Webhook secret” 下，输入一个字符串作为 secret 密钥。请使用高熵的随机字符串。您可以使用 Webhook secret 来限制仅接受来自 GitHub 的请求。有关详细信息，请参阅 验证 Webhook 投递。

  9. 点击 保存更改。

  10. 在侧边栏，点击 权限与事件。

  11. 您可以为 GitHub 应用注册选择的具体 Webhook 事件取决于您为应用选择的权限类型。您需要先选择应用应具备的权限，然后才能订阅与该权限集合相关的 Webhook 事件。

    在 “Repository permissions”、 “Organization permissions” 与 “Account permissions” 部分，勾选您的应用需要的、对应于其将要订阅事件的权限。有关详细信息，请参阅 选择 GitHub 应用的权限。有关更改权限时需考虑的事项，请参阅 修改 GitHub 应用注册。

  12. 在 “Subscribe to Events” 下，选择您希望 GitHub 应用收到的 Webhook 事件。

  13. 点击 保存更改。

您也可以使用 REST API 为 GitHub 应用创建 Webhook。有关详细信息，请参阅 GitHub 应用 Webhook 的 REST API 端点。

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.