イベント · 質問と回答
gap.detected
ナレッジギャップが検出された
ナレッジギャップが見つかりました:類似の質問に回答がないままです。
- オブジェクトの種類
- gap
- 配信先
- オブジェクトを参照できるWebhook(ロール、データプロファイル、コレクションによる)
ペイロード
idstring必須イベントのID(
evt_…)。webhook-idヘッダーとしても送信されます。重複した配信を破棄するために使ってください。typestring必須指定できる値:
gap.detectedcreated_atstring (date-time)必須変更が発生した日時(UTC)。
org_idinteger必須api_versionstring必須dataスキーマの契約のバージョン。sequenceintegerWebhook内での配信の連番(テストイベントにはありません)。
payloadstring必須thinはdataがないことを意味します:APIでオブジェクトを読み取ってください。指定できる値:
fullthindataobjectフィールド
testboolean必須POST /v1/webhooks/{webhook_id}/testで送信されたテストイベント。
配信の例
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "gap.detected",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "gap",
"id": "3051"
},
"payload": "full",
"data": {
"gap": {
"question_id": 3051,
"representative": "How do I request a refund?",
"count": 6,
"first_at": "2026-10-17T08:12:00Z",
"last_at": "2026-10-24T09:40:00Z",
"collection_ids": [
3
],
"days": 7
}
},
"test": false
}イベントの受信
各配信は、このJSONボディを持つPOSTリクエストとしてWebhookの受信先URLに送られます。ボディを信頼する前にwebhook-signatureヘッダー(Standard Webhooks)を検証し、数秒以内に2xxステータスで応答してから、処理を行ってください。1つのWebhookへの配信はイベントの順序を保ちます。失敗した配信は間隔を広げながら再試行されます。
新しいイベントタイプや新しいフィールドはいつでも追加されることがあります。知らないタイプとフィールドは無視してください。