Webhookとイベント
Webhookとは、システム間の非同期統合を可能にするシステム通知サービスです — Unico IDCloudは、プロセスが状態を変化させるたびにバックエンドに通知するため、更新をポーリングする必要がありません。
このセクションでは、Webhookを統合するために必要な4つの事項を説明します: エンドポイントと認証の設定方法、Unicoが送信するイベント、フォールバック戦略、およびエンドポイントが実装しなければならないセキュリティと信頼性パターンです。
Webhookを使用する場面
Webhookは、プロセスの完了を通知される推奨方法です。特に以下の場合に適しています:
- ビジュアルフロー (SDK / Web Redirect / iFrame) — ユーザーがジャーニーを完了したことを知るため。
- 非同期Web & SDKフロー —
POST /client/v1/processがUnicoの側で処理を完了したときに通知を受けるため。 - 複数の機能を組み合わせた長時間実行フロー (例: ドキュメント分析 + 手動レビュー)。Webhookは終端状態 (
PROCESS_STATE_FINISHED) のときのみ発火します。途中の進捗イベントは配信されません。
WebhookはGetProcessエンドポイントを補完しますが、置き換えるものではありません。フォールバックを参照してください。