Webhooks

Webhooks 允许你的外部系统在 NuxtBase 组织中发生事件时接收实时通知。

设置 Webhook

1. 进入侧边栏的 Webhooks 页面
2. 点击 创建 Webhook
3. 输入接收事件的端点 URL
4. 选择要订阅的事件类型
5. 保存 Webhook

工作原理

当订阅的事件发生时：

1. NuxtBase 向你的端点 URL 发送 HTTP POST 请求
2. 请求体包含 JSON 格式的事件类型和相关数据
3. 你的服务器处理事件并返回 2xx 状态码
4. 如果投递失败，NuxtBase 会重试请求

投递追踪

每个 Webhook 端点显示：

• 投递历史 — 所有已发送事件的日志
• 状态 — 每次投递是否成功
• 响应码 — 你的服务器返回的 HTTP 状态码
• 时间戳 — 投递尝试的时间

管理 Webhooks

编辑 Webhook

随时更新端点 URL 或更改订阅的事件类型。

禁用 Webhook

临时禁用 Webhook 而不删除它。禁用的 Webhook 停止接收事件但保留配置。

删除 Webhook

永久移除 Webhook 端点。待发送到已删除端点的投递将被取消。

最佳实践

• 使用 HTTPS — 始终使用 HTTPS 端点确保数据传输安全
• 快速响应 — 在几秒内返回 2xx 响应以确认收到
• 异步处理 — 将接收到的事件排入队列进行后台处理，而不是在请求中直接处理
• 验证载荷 — 验证传入的 Webhook 载荷，确保它们来自 NuxtBase