测试WebHook是否发送成功¶

POST /api/v5/repos/{owner}/{repo}/hooks/{id}/tests

该接口用于测试指定仓库的WebHook是否发送成功，通过触发一次测试请求，帮助开发者验证WebHook配置及回调地址的连通性，以便及时排查和修复推送通知异常问题。

访问令牌支持说明¶

AtomGit 用户访问令牌（AtomGit user access tokens）

是否允许匿名访问¶

此接口不允许匿名访问

请求参数¶

参数名	位置	类型	必填	说明
`owner`	path	string	是	仓库所属空间地址（企业、组织或个人的地址path）
`repo`	path	string	是	仓库路径(path)
`id`	path	string	是	Webhook的ID
`access_token`	query	string	是	用户授权码

响应参数¶

该接口成功时返回空对象 {{}}，无响应字段。

失败响应¶

除成功响应外，调用方还需了解失败时的返回形态。以下示例仅为通用形态，错误字段名以后端实际返回为准。

401 未认证

{{
  "message": "未认证或访问令牌无效"
}}

404 资源不存在

{{
  "message": "仓库或WebHook不存在"
}}

HTTP 响应状态码¶

状态码	说明
`200`	成功（OK）
`401`	需要认证（Requires authentication）
`403`	禁止访问（Forbidden）
`404`	资源不存在（Not found）

请求示例¶

参数说明¶

<owner> 替换为仓库所属空间地址（企业、组织或个人的地址path）；<repo> 替换为仓库路径(path)；<id> 替换为Webhook的ID；<token> 替换为你的 AtomGit 用户访问令牌。

cURL¶

curl -X POST 'https://api.atomgit.com/api/v5/repos/<owner>/<repo>/hooks/<id>/tests?access_token=<token>' \
  -H 'Accept: application/json'

JavaScript¶

// 原生 fetch (Node.js 18+ / 浏览器)
const response = await fetch(
  "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/hooks/<id>/tests?access_token=<token>",
  {{
    method: "POST",
    headers: {{
      "Accept": "application/json",
    }},
  }}
);

if (!response.ok) {{
  throw new Error(`请求失败: ${{response.status}}`);
}}

const data = await response.json();
console.log(data);

Python¶

import requests

resp = requests.post(
    "https://api.atomgit.com/api/v5/repos/<owner>/<repo>/hooks/<id>/tests",
    params={{"access_token": "<token>"}},
    headers={{"Accept": "application/json"}},
    timeout=10,
)
resp.raise_for_status()

print(resp.json())

响应示例¶

状态码： 200

{{}}

错误码¶

错误码	说明
`400`	参数错误或请求无法解析
`401`	未认证或凭证无效
`403`	禁止访问
`404`	请求路径不存在
`500`	系统内部错误

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 gitcode-dev/atomgit-api-doc