测试 Webhook —— 控制台工具与监控
finlight 控制台提供全面的测试和监控工具,确保您的 webhook 集成可靠运行。使用这些内置功能来验证、测试和调试您的 webhook 端点。
概览
控制台功能概览
关键的控制台工具
Webhook 列表:
- 查看您配置的所有 webhook
- 一目了然地看到状态(已启用/已禁用)
- 快速访问 webhook 详情
Webhook 详情页:
- 配置选项卡 —— 查看/编辑 webhook 设置
- 调用历史选项卡 —— 查看所有投递尝试
- 测试按钮 —— 手动测试功能
调用历史功能:
- 状态过滤 —— 仅显示成功或失败
- 详细日志 —— 点击条目查看完整的请求/响应数据
控制台管理界面
Webhook 详情控制台
在 app.finlight.me/news-webhooks 访问您的 webhook 管理界面,查看和管理您的所有 webhook。
访问 Webhook 详情
- 导航到控制台中的 webhook 列表
- 点击 webhook 的 “Show” 按钮以查看其详情页
- 查看有关 webhook 配置和性能的全面信息
webhook 详情页提供:
- 配置概览 —— 当前设置和过滤条件
- 调用历史 —— 所有 webhook 尝试的完整日志
- 测试控件 —— 手动测试功能
- 编辑控件 —— 创建后手动编辑
测试测试按钮
手动测试
测试 Webhook 功能
控制台包含一个 “Test” 按钮,可向您的端点发送示例负载:
使用方法:
- 打开您的 webhook 详情页
- 点击顶部面板上的 “Test” 按钮
- 等待几秒钟让测试请求完成
- 在调用历史中查看测试结果(可能需要刷新页面)
会发生什么:
- 向您配置的端点发送一个逼真的示例负载
- 使用您实际的认证设置
- 包含正确的签名验证标头
- 在您的调用历史中记录此次测试尝试
测试负载: 该测试会发送一个模拟文章事件,其结构与真实的 webhook 投递相同,使您能够验证:
- 端点的可访问性与响应
- 认证配置
- 负载处理逻辑
- 错误处理能力
历史投递日志
调用历史与监控
查看调用历史
webhook 详情页显示一份全面的调用历史,展示所有投递尝试:
显示的信息:
- 时间戳 —— webhook 的发送时间
- 状态 —— 成功 (2xx) 或失败 (4xx/5xx)
- 响应代码 —— 您端点返回的 HTTP 状态码
- 响应时间 —— 您端点的响应耗时
- 响应 —— 点击 “Show” 后,下拉内容中显示完整响应(标头和正文)
成功请求与失败请求
成功请求 (✅):
- HTTP 状态码 200-299
- 在超时时间内收到响应
- 来自您端点的正确确认
失败请求 (❌):
- HTTP 状态码 400-599
- 网络超时或连接错误
- 认证失败
- 无效的端点 URL
调试故障排除
使用控制台进行调试
使用调用历史进行调试
调用历史是您诊断 webhook 问题的主要工具:
识别模式:
- 按状态过滤 —— 仅查看失败的请求以识别问题
- 检查时间戳 —— 寻找失败中的时间模式
- 查看响应代码 —— 了解您的端点返回了什么
- 检查重试尝试 —— 查看投递被尝试了多少次
常见的失败指标:
- HTTP 401/403 —— 认证或授权问题
- HTTP 404 —— 端点 URL 不正确
- HTTP 500 —— 您应用中的内部服务器错误
- 超时 —— 您的端点响应耗时过长
- 连接错误 —— 网络连接问题
详细的错误信息
点击任意调用历史条目可查看:
- 发送到您端点的完整请求标头
- 从您端点收到的响应标头
- 响应正文内容(如有)
- 精确的计时信息
- 失败尝试的重试历史
要求实现准则
端点要求
响应要求
您的 webhook 端点必须:
HTTP 响应:
- 成功处理时返回状态码 200-299
- 在 30 秒内响应以避免超时
- 接受带 JSON 负载的 POST 请求
标头:
- 处理
X-Webhook-Signature以进行签名验证 - 处理
X-Webhook-Timestamp以防止重放攻击 - 支持您所选认证方式的标头
有关 webhook 设置指南,请参阅 webhooks 主文档。有关认证详情,请查看认证指南。