快速开始

本指南帮助你在 5 分钟内从零开始，成功捕获一个 Webhook 请求。

前提条件

• 一个现代浏览器（Chrome、Firefox、Safari 或 Edge）
• 一个 GitHub 账号（目前仅支持 GitHub OAuth 登录）

操作步骤

1. 创建账号

   访问 hooknexus.com 并点击 登录，在浏览器中完成 GitHub OAuth 即可注册或进入已有账号。

2. 创建端点

   登录后进入 Dashboard。点击 New Endpoint 生成一个唯一的 Webhook URL。

   你的端点 URL 格式如下：

   https://api.hooknexus.com/h/a1b2c3d4-e5f6-7890-abcd-ef1234567890

3. 复制 URL

   点击 URL 旁边的 复制 按钮。接下来我们用这个地址发送测试请求。

4. 发送测试请求

   打开终端，运行以下命令：

   cURL

   curl -X POST https://api.hooknexus.com/h/你的端点ID \
     -H "Content-Type: application/json" \
     -d '{"event":"test","message":"你好 HookNexus！"}'

   JavaScript

   fetch('https://api.hooknexus.com/h/你的端点ID', {
     method: 'POST',
     headers: { 'Content-Type': 'application/json' },
     body: JSON.stringify({
       event: 'test',
       message: '你好 HookNexus！',
     }),
   });

   Python

   import requests
   
   requests.post(
       'https://api.hooknexus.com/h/你的端点ID',
       json={'event': 'test', 'message': '你好 HookNexus！'},
   )

   将 你的端点ID 替换为第 3 步中复制的实际 ID。

5. 查看请求

   切换回 HookNexus Dashboard。你的测试请求会立即出现在左侧面板中。点击它可以查看：

   • 方法 — POST
   • 请求头 — Content-Type, User-Agent 等
   • 请求体 — 你发送的 JSON 内容，带语法高亮

6. 用 CLI 把 Webhook 转到本机

   若要把线上收到的请求转发到本地 HTTP 服务，可安装 官方 CLI（GitHub 源码）并建立转发（Free 与 Plus 均支持）：

   npm install -g hooknexus
   hooknexus login
   hooknexus forward --to http://localhost:PORT/PATH

   将 PORT、PATH 换成本机实际接收转发请求的端口与路径（须为含路径的完整 URL，不能只有域名或根地址，说明见 本地转发）。若账号下只有一个 endpoint，CLI 通常会自动选用；否则可显式指定 endpoint id。保持该进程运行并启动本地应用。更多选项见 本地转发（如 --preserve-path、--allow-external 与安全说明）。

提示

Dashboard 使用 WebSocket 实时更新 — 无需刷新页面。

下一步

成功捕获你的第一个 Webhook 后，可以继续探索：

• CLI 工具 — 安装、命令、转发与故障排查（hooknexus/hooknexus-cli）
• 核心概念 — 了解端点、请求生命周期和订阅计划
• 接收 Webhook — 配置第三方服务发送 Webhook
• 订阅方案 — Free 与 Plus 配额与功能
• Stripe 集成 — 分步 Stripe Webhook 设置教程