跳转到主要内容

Webhooks 与事件

Webhook 是一种系统通知服务,允许系统之间进行异步集成——每当流程状态发生变化时,Unico IDCloud 会通知您的后端,因此您无需轮询更新。

本节涵盖集成 Webhook 所需的四个方面:如何配置端点和认证、Unico 发送的事件回退策略,以及您的端点必须实现的安全与可靠性模式。

何时使用 Webhook

Webhook 是接收流程完成通知的推荐方式。以下场景尤为适用:

  • 异步 Web 与 SDK 流程——在 POST /client/v1/process 于 Unico 侧处理完成时接收通知。
  • 长时运行流程——组合了多项能力(例如文件分析 + 人工审核)。Webhook 仅在终态(PROCESS_STATE_FINISHED)时触发;不会推送任何中间进度事件。

Webhook 是对 GetProcess 端点的补充,但不能替代它。请参阅回退机制

本节内容

  • 配置 — 端点注册、认证方式(OAuth2、Basic、API Key)、重试设置。
  • 事件类型 — Unico 发送的事件及载荷结构。
  • 安全 — 幂等性、并发限制和错误率。
  • 回退 — webhook 不可用时如何获取流程结果。