Webhooksイベントタイプ

Challenge.StateChange

チャレンジの状態が変更されたときに発行されます。

配信とリカバリー

webhookイベントは失敗時に最大2回リトライされます。サーバーがイベントを受信できなかった場合、保存したチャレンジIDを使用してGET /challenge/get-statusをポーリングしてください。詳細は配信、リトライ、リカバリーを参照してください。

保護者の同意チャレンジは期限切れになりません

保護者の同意チャレンジは、信頼できる大人が承認または拒否するまで保留状態のままになります。期限切れになるのはアクセス方法(OTP、QRコード、メールリンク)のみで、チャレンジ自体は期限切れになりません。詳細については、チャレンジの有効期限と時間ベースの認証 を参照してください。

フィールド

フィールドタイプ必須説明
eventTypestringはい常に "Challenge.StateChange"
dataobjectはいチャレンジ状態変更データ
data.idstring (UUID)はいチャレンジID
data.productIdnumberはいプロダクトID
data.statusstringはいPASS、FAIL、IN_PROGRESS のいずれか
data.typestringはいチャレンジタイプ。次のいずれか: CHALLENGE_SESSION_UPGRADE, CHALLENGE_SESSION_UPGRADE_BY_AGE_ASSURANCE, CHALLENGE_PARENTAL_CONSENT, CHALLENGE_AGE_ATTESTATION, CHALLENGE_CUSTOM, CHALLENGE_BULK_APPROVAL_REQUEST, CHALLENGE_UPDATE_JURISDICTION, CHALLENGE_MATERIAL_CHANGE, CHALLENGE_AGE_GATE_AGE_ASSURANCE, CHALLENGE_PARENT_INVITE
data.dobstring (YYYY-MM-DD)いいえプレイヤーの生年月日;利用可能な場合に存在
data.sessionIdstring (UUID)いいえstatus が PASS の場合に存在
data.approverEmailstringいいえ信頼できる大人がチャレンジを承認したときの PASS イベントに存在
data.kuidstringいいえk-IDユーザーID;利用可能な場合に存在
data.widgetIdstring (UUID)いいえチャレンジの開始元のウィジェット。エンドツーエンドウィジェットまたは年齢ゲートウィジェットから開始したチャレンジの場合に存在。サーバーで結果を取得するを参照

例

{
  "eventType": "Challenge.StateChange",
  "data": {
    "id": "9d6b056e-7d62-4a9e-907a-3d0f6f1d1b9a",
    "productId": 11472,
    "status": "PASS",
    "type": "CHALLENGE_PARENTAL_CONSENT",
    "dob": "2011-07-12",
    "sessionId": "b6d1a7c2-8f34-4c83-bf0b-3a6d4a2f9d31",
    "approverEmail": "parent@example.com",
    "kuid": "7a1f2c3d-4e5f-6789-abcd-ef0123456789",
    "widgetId": "2f6c1d3e-8a4b-4c5d-9e6f-7a8b9c0d1e2f"
  }
}

On this page