Events · Bronnen en import
import.document_failed
Import van document mislukt
Een document van een eigen bron is niet geïmporteerd of niet geïndexeerd (data.reason is een neutrale code).
- Objecttype
- source
- Geleverd aan
- Webhooks met de rol admin
Payload
Object: EventImportDocumentFailed
idstringverplichtID van het event (
evt_…), ook meegestuurd als headerwebhook-id. Gebruik die om dubbele leveringen te negeren.typestringverplichtToegestane waarden:
import.document_failedcreated_atstring (date-time)verplichtWanneer de wijziging plaatsvond (UTC).
org_idintegerverplichtapi_versionstringverplichtContractversie van het schema van
data.sequenceintegerVolgnummer van de levering binnen de webhook (ontbreekt bij een testevent).
payloadstringverplichtthinbetekent geendata: lees het object via de API.Toegestane waarden:
fullthindataobjectVelden
documentobjectverplichtHet document van de eigen bron; het documentresultaat van de push-API meldt dezelfde uitkomst.
Velden
external_idstring | nullverplichttitlestring | nullcard_idstring | nullverplicht
run_idintegerjob_idinteger | nullDe indexerings- of exportjob.
reasonstringverplichtNeutrale redencode (uitbreidbare enumeratie: behandel een onbekende code als een algemene fout). De waarden zijn uitkomstcodes van documenten:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanverplichtEen testevent, verstuurd door
POST /v1/webhooks/{webhook_id}/test.
Voorbeeldlevering
{
"id": "evt_0123456789abcdef0123456789abcdef",
"type": "import.document_failed",
"created_at": "2026-10-24T10:00:03Z",
"org_id": 1,
"api_version": "1.62.0",
"sequence": 1042,
"object": {
"type": "source",
"id": "5"
},
"payload": "full",
"data": {
"source": {
"id": 5,
"name": "Help center",
"kind": "custom",
"collection_id": 3
},
"document": {
"external_id": "kb-article-118",
"title": "Shipping rates",
"card_id": null
},
"run_id": 902,
"reason": "content_invalid"
},
"test": false
}Events ontvangen
Elke levering is een POST-request met deze JSON-body naar het ontvangstadres van je webhook. Controleer de header webhook-signature (Standard Webhooks) voordat je de body vertrouwt, antwoord binnen een paar seconden met een 2xx-status en doe het werk daarna. Leveringen aan één webhook behouden de volgorde van de events; een mislukte levering wordt met steeds langere pauzes opnieuw geprobeerd.
Er kunnen op elk moment nieuwe eventtypes en nieuwe velden bij komen: sla de types en velden over die je niet kent.