创建 web 挂钩

关于创建 Webhook

可以创建 Webhook 来订阅在存储库、组织或 GitHub Enterprise 中发生的 GitHub 上的特定事件。还可以将 GitHub App 设置为在 GitHub 上发生特定事件时接收 Webhook。

有关不同类型的 Webhook 的详细信息，请参阅“关于 web 挂钩”。有关 Webhook 事件的完整列表，请参阅“Webhook 事件和有效负载”。

可以创建 Webhook 以订阅在特定存储库中发生的事件。必须是存储库所有者，或在存储库中具有管理员访问权限的人员，才能在该存储库中创建 Webhook。

可以使用 GitHub Web 界面或 REST API 来创建存储库 Webhook。有关使用 REST API 来创建存储库 Webhook 的详细信息，请参阅“存储库 Webhook”。

在你的企业上，导航到存储库的主页。
在存储库名称下，单击 “设置”。如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”********。
在左侧边栏中，单击 “Webhook”。
单击“添加 Webhook” 。
在“有效负载 URL”下，键入要接收有效负载的 URL。
（可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。
- application/json 直接将 JSON 有效负载作为 POST POST 请求的正文传递。
- application/x-www-form-urlencoded 将 JSON 有效负载作为表单参数发送，称为 payload。
（可选）在“机密”下，键入用作 secret 密钥的字符串。应选择高熵的随机文本字符串。可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。有关详细信息，请参阅“Validating webhook deliveries”。
在“你希望通过哪些事件来触发此 Webhook？”下，选择要接收的 Webhook 事件。应仅订阅需要的 Webhook 事件。
如果选择****“让我选择单个事件”，请选择你希望触发 Webhook 的事件。
要在添加配置后使 Webhook 处于活动状态，请选择“活动”。
单击“添加 Webhook” 。

创建新的 Webhook 后，GitHub 将向你发送一个简单的 ping 事件，告知你已正确设置 Webhook。有关详细信息，请参阅“Webhook 事件和有效负载”。

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

可以使用 GitHub Web 界面或 REST API 来创建组织 Webhook。有关使用 REST API 来创建组织 Webhook 的详细信息，请参阅“组织 web 挂钩”。

在你的企业上任意页的右上角，单击你的个人资料照片。
单击“你的组织”。
在组织右侧，单击“设置”。
在左侧边栏中，单击 “Webhook”。
单击“添加 Webhook” 。
在“有效负载 URL”下，键入要接收有效负载的 URL。
（可选）选择“内容类型”下拉菜单，然后单击一种数据格式以接收 Webhook 有效负载。
- application/json 直接将 JSON 有效负载作为 POST POST 请求的正文传递。
- application/x-www-form-urlencoded 将 JSON 有效负载作为表单参数发送，称为 payload。
（可选）在“机密”下，键入用作 secret 密钥的字符串。应选择高熵的随机文本字符串。可以使用 Webhook 机密，将传入请求限制为仅源自 GitHub 的请求。有关详细信息，请参阅“Validating webhook deliveries”。
在“你希望通过哪些事件来触发此 Webhook？”下，选择要接收的 Webhook 类型。应仅订阅需要的 Webhook 事件。
如果选择“让我选择单个事件”****，请选择将会触发 Webhook 的事件。
要在添加配置后使 Webhook 处于活动状态，请选择“活动”。
单击“添加 Webhook” 。

创建新的 Webhook 后，GitHub 将向你发送一个简单的 ping 事件，告知你已正确设置 Webhook。有关详细信息，请参阅“Webhook 事件和有效负载”。

创建全局 Webhook

企业所有者可以创建全局 Webhook 以订阅在企业中发生的事件。有关详细信息，请参阅“管理全局 web 挂钩”。

可以让 GitHub App 订阅 Webhook 事件，在每次发生特定事件时接收通知。有关详细信息，请参阅“注册 GitHub 应用”和“将 Webhook 与 GitHub 应用配合使用”。