Webhooks¶
Webhook 用于在仓库事件发生时向外部地址推送 HTTP 回调。通过 API 可以创建、查询、更新、删除仓库 Webhook，并触发一次测试投递来验证地址是否可达。
对象¶
| 对象 | 说明 | 相关接口 |
|---|---|---|
| Webhook | 回调地址、事件类型、密钥与启用状态 | 列出仓库的WebHooks |
| 测试投递 | 向配置的地址发一次测试请求，验证连通性 | 测试Webhook是否发送成功 |
标识方式¶
- 仓库用
owner+repo，Webhook 用id标识。 - 路径段是
hooks，不是webhooks。
常见任务¶
| 任务 | 接口 |
|---|---|
| 列出 Webhook | GET /api/v5/repos/{owner}/{repo}/hooks |
| 创建 Webhook | POST /api/v5/repos/{owner}/{repo}/hooks |
| 获取单个 Webhook | GET /api/v5/repos/{owner}/{repo}/hooks/{id} |
| 更新 Webhook | PATCH /api/v5/repos/{owner}/{repo}/hooks/{id} |
| 删除 Webhook | DELETE /api/v5/repos/{owner}/{repo}/hooks/{id} |
| 测试投递 | POST /api/v5/repos/{owner}/{repo}/hooks/{id}/tests |
注意事项¶
- 路径段是
hooks（不是webhooks），照文档标题拼路径会 404。 - 测试投递的路径末尾是复数
tests，方法必须是POST。 - 更新用
PATCH，只提交要改的字段；改回调地址或密钥后建议先跑一次测试投递。 - 组织级、企业级 Webhook 不在本组，本组只有仓库维度。
接口列表¶
本模块共 6 个接口。
| # | 接口 | 方法与路径 | 说明 |
|---|---|---|---|
| 1 | 列出仓库的WebHooks | GET /api/v5/repos/{owner}/{repo}/hooks |
该接口用于列出指定仓库已配置的 WebHooks，返回各 Webhook 的 ID、触发事件类型、激活状态及创建时间… |
| 2 | 创建仓库的WebHooks | POST /api/v5/repos/{owner}/{repo}/hooks |
该接口用于为指定仓库创建 WebHooks，可设置接收事件的远程 HTTP URL、请求密码及加密类型，并配置 Pu… |
| 3 | 获取仓库单个WebHook | GET /api/v5/repos/{owner}/{repo}/hooks/{id} |
该接口用于获取指定仓库中单个 WebHook 的配置详情，包括回调地址、订阅的事件类型、最近一次推送的返回结果及激活… |
| 4 | 更新仓库WebHook | PATCH /api/v5/repos/{owner}/{repo}/hooks/{id} |
该接口用于更新指定仓库下的某个 WebHook，可修改其远程通知 URL、加密类型与请求密码，并配置各事件类型的触发… |
| 5 | 删除仓库WebHook | DELETE /api/v5/repos/{owner}/{repo}/hooks/{id} |
该接口用于删除指定仓库下的一个 WebHook，通过仓库所属空间地址、仓库路径及 WebHook 的 ID 定位目标… |
| 6 | 测试WebHook是否发送成功 | POST /api/v5/repos/{owner}/{repo}/hooks/{id}/tests |
该接口用于测试指定仓库的WebHook是否发送成功，通过触发一次测试请求，帮助开发者验证WebHook配置及回调地址… |
本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc