はじめに
連携 / SDK
ユーザー認証
法人確認
トランザクションモニタリング
変更履歴イベントカタログ
activity.createdはsubscribed_eventsに指定でき、Try Webhookテスターの対象にもなっていますが、Diditは現在、本番トラフィックではこのイベントを配信していません。
このイベントに基づくタイムラインのミラーリングを実装しないでください。- KYBのWebhook：企業セッションのイベント
- トランザクションモニタリングのWebhook：取引のイベント
- Webhookリファレンス：署名検証、再試行、送信先
ペイロードの形式
エンティティWebhookはフラットな構造で、dataラッパーもeventキーもありません。
イベントの振り分けにはwebhook_typeを参照してください。
user.status.updated / business.status.updated
ステータスが変わるたびに送信されます。
ペイロードにはstatusとprevious_statusが含まれます。
ステータスが変わった理由は含まれないため、原因を知る必要がある場合はコンソールでエンティティを開いてください。
user.data.updated / business.data.updated
プロフィールフィールドが変わったときに送信されます。
changed_fieldsには変更されたフィールドの一覧が、changesには各フィールドのpreviousとcurrentの値が入ります。
changed_fieldsに含まれる可能性のあるフィールドは次のとおりです。
- ユーザー：
vendor_data、display_name、full_name、date_of_birth、metadata、portrait_image、issuing_states、approved_emails、approved_phones、features、session_count、approved_count、declined_count、in_review_count、first_session_at、last_session_at。 - 企業：
vendor_data、display_name、metadata、legal_name、registration_number、country_code、session_count、approved_count、declined_count、in_review_count、features、first_session_at、last_session_at。
changed_fieldsとchangesを使えば、変更されたフィールドだけを同期できます。
配信、再試行、署名
すべてのエンティティWebhookは、標準の配信仕様に従います。- 署名：送信先の
secret_shared_keyを使い、HMAC-SHA256でX-Signature-V2ヘッダーに署名されます（推奨）。X-Signatureと非推奨のX-Signature-Simpleも、X-Timestampとあわせて送信されます。 - 再試行：エンドポイントが5xxまたは404を返した場合、タイムアウトした場合、接続に失敗した場合に、約1分後と約4分後の最大2回まで再試行されます。ポリシーの詳細はWebhookリファレンスを参照してください。
- 冪等性：すべてのWebhookのペイロードには一意の
event_idが含まれます。受信側で重複を排除してください。
サブスクライブ
Management APIまたはBusiness Consoleから、Webhookの送信先でエンティティイベントをサブスクライブします。次のステップ
Webhookリファレンス
送信先、署名、再試行、検証。
送信先を作成
新しいWebhookエンドポイントを登録します。
ユーザー操作
ユーザーWebhookをトリガーする変更。