メインコンテンツに移動

Webhooksの概要

Webhooksは、チャレンジステータスの変更や確認結果など、k-IDの重要なイベントについてサーバーに通知します。各製品の開発者設定で、Compliance Studioでwebhook URLとシークレットを設定します。

ペイロードにはeventTypeとdataオブジェクトが含まれます。ペイロードスキーマについては、イベントタイプを参照してください。

イベントタイプ​

イベントタイプ説明
Challenge.StateChange親の同意チャレンジの状態が変更されたときに発行される
Verification.Result確認試行の結果とともに発行される
Account.Deleteアカウントが削除されたときに発行される
AgeAssurance.ResultAge Assurance評価の結果とともに発行される（非推奨、Verification.Resultに置き換え）
ParentalConsent.Granted親の同意が付与されたときに発行される
Session.ChangePermissions親によってセッション権限が変更されたときに発行される
Session.Deleteセッションが削除されたときに発行される
Testwebhookが正しく機能していることを確認するために使用される

署名の検証​

設定されたwebhookシークレットでwebhookリクエストを検証します。

ヘッダー​

各リクエストとともに送信されるヘッダー：

  • X-Signature-Timestamp: UNIXエポック秒
  • X-Signature-Hmac-Sha256: （タイムスタンプ + 生の本文）のHMAC SHA-256。webhookシークレットをキーとして使用し、16進数エンコード（小文字）

期待される動作​

  • 有効な署名の場合は200を返す
  • 無効な署名の場合は401を返す

実装の詳細については、Webhookリクエストの検証を参照してください。