Webhooks
Webhooks 概览
使用 Webhooks 接收来自 Curosa 平台的实时更新
概览
Webhooks 允许 Curosa 实时向您的系统推送事件通知。您无需重复轮询 API 接口,只需订阅相关事件,并在更新发生时实时处理。
Webhooks 工作原理
- 在您的供应商门户中配置一个公开的 HTTPS 端点。
- 为该端点订阅一个或多个事件类型。
- 当事件发生时,Curosa 会向您的端点发送一个带有 JSON 负载的
POST请求。 - 您的端点返回
2xx响应以确认处理成功。
发送格式
Webhook 请求以 JSON 格式发送:
| 属性 | 值 |
|---|---|
| 方法 | POST |
| 请求头 | Content-Type: application/json |
| 正文 | 事件负载 |
负载结构和特定事件的字段已在 Webhook 事件 中说明。
端点要求
您的 Webhook 端点应当:
- 可通过 HTTPS 公开访问
- 在接收到负载时快速返回
2xx响应 - 安全地处理重试(建议进行幂等处理)
- 记录请求失败情况以便进行运行监控
安全建议
- 在处理之前验证传入请求是否来自受信任的基础架构
- 将 Webhook 负载视为不可信输入并验证字段
- 避免执行耗时的内联处理;尽可能将任务加入队列
- 仅使用 HTTPS,切勿在 Webhook URL 中泄露密钥 (Secrets)
重试机制
如果您的端点返回非 2xx 状态码或超时,系统可能会根据队列配置重试发送。请将处理程序设计为幂等的,以确保重复发送时的安全性。
后续步骤
- 在 Webhook 事件 中查看支持的事件
- 根据请求负载中的
event字段实现事件路由