Webhookとイベント

Markdown

Webhookとは、システム間の非同期統合を可能にするシステム通知サービスです — Unico IDCloudは、プロセスが状態を変化させるたびにバックエンドに通知するため、更新をポーリングする必要がありません。

このセクションでは、Webhookを統合するために必要な4つの事項を説明します: エンドポイントと認証の設定方法、Unicoが送信するイベント、フォールバック戦略、およびエンドポイントが実装しなければならないセキュリティと信頼性パターンです。

Webhookを使用する場面

Webhookは、プロセスの完了を通知される推奨方法です。特に以下の場合に適しています:

• Human Token Journey（humantoken、humantoken+revalidation）— プロセスの作成で作成したプロセスのジャーニーをユーザーが完了したときに通知を受けるため。Webhookは終端状態（PROCESS_STATE_FINISHED）のときのみ発火します。途中の進捗イベントは配信されません。
• API Only フロー（api+humantoken、api+liveness+humantoken、api+liveness+humantoken+revalidation）— 結果はプロセスの作成のレスポンスですでに返されるため、これらのフローはWebhookに依存しません。

WebhookはGetProcessエンドポイントを補完しますが、置き換えるものではありません。フォールバックを参照してください。

このセクションの内容

• セットアップ — エンドポイントの登録、認証方法（OAuth2、Basic、APIキー）、リトライ設定。
• イベントタイプ — Unicoが送信するイベントとペイロード構造。
• セキュリティ — 冪等性、同時実行数制限、エラーレート。
• フォールバック — Webhookが利用できない場合のプロセス結果の取得方法。