用途:在设计 Webhook 和异步 API 时使用,适用于事件驱动通知(如订单状态变化、支付成功)、第三方集成(GitHub Actions、CI/CD)、长时间任务(导出报表、视频转码)和异步处理(消息队列)。
主要能力:给出事件 Payload 结构(含 id、type、created_at、version、data、previous、metadata)与事件命名规范(resource.action);设计 HMAC-SHA256 签名与时间戳防重放(5 分钟内);制定指数退避加抖动的重试时间表(1m/5m/30m/2h/12h/24h,最多约 10 次);设计异步长任务模式,提交返回 HTTP 202 与 task_id、status_url,并提供任务状态机(pending→running→completed/failed/cancelled)及轮询、Webhook、SSE、WebSocket 等状态获取方式;还包含端点注册、测试接口与质量自检清单。
使用方式:按工作流程先识别需要 Webhook 与异步的场景,列事件清单并命名,设计 Payload、签名、重试与任务状态查询,提供测试方式,最后输出文档。接收方应收到后立即返回 200、验证签名、用 event_id 去重、失败重新入队并控制处理超时。
限制:资料未提供具体实现代码库、部署方式、收费或平台信息;示例中的重试次数、超时等参数为建议值,需按实际业务调整。