Ereignisse · Quellen und Import
import.document_failed
Import eines Dokuments fehlgeschlagen
Ein Dokument einer benutzerdefinierten Quelle wurde nicht importiert oder nicht indexiert (data.reason ist ein neutraler Code).
- Objekttyp
- source
- Zugestellt an
- Endpunkte mit der Rolle admin
Payload
Objekt: EventImportDocumentFailed
idstringerforderlichEreignis-ID (
evt_…), auch als Headerwebhook-idgesendet. Verwenden Sie sie, um doppelte Zustellungen zu verwerfen.typestringerforderlichZulässige Werte:
import.document_failedcreated_atstring (date-time)erforderlichWann die Änderung stattgefunden hat (UTC).
org_idintegererforderlichapi_versionstringerforderlichVertragsversion des Schemas von
data.sequenceintegerLaufende Nummer der Zustellung innerhalb des Endpunkts (fehlt bei einem Testereignis).
payloadstringerforderlichthinbedeutet keindata: Lesen Sie das Objekt über die API.Zulässige Werte:
fullthindataobjectFelder
documentobjecterforderlichDas Dokument der benutzerdefinierten Quelle; das Ergebnis des Dokuments in der Push-API meldet dasselbe.
Felder
external_idstring | nullerforderlichtitlestring | nullcard_idstring | nullerforderlich
run_idintegerjob_idinteger | nullDer Indexierungs- oder Exportjob.
reasonstringerforderlichNeutraler Code des Grundes (erweiterbare Aufzählung: Behandeln Sie einen unbekannten Code als allgemeinen Fehlschlag). Die Werte sind Ergebniscodes von Dokumenten:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanerforderlichEin Testereignis, gesendet durch
POST /v1/webhooks/{webhook_id}/test.
Beispielzustellung
{
"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
}Ereignisse empfangen
Jede Zustellung ist eine POST-Anfrage mit diesem JSON-Body an Ihren Endpunkt. Prüfen Sie den Header webhook-signature (Standard Webhooks), bevor Sie dem Body vertrauen, antworten Sie innerhalb weniger Sekunden mit einem Status 2xx und erledigen Sie die Arbeit danach. Zustellungen an einen Endpunkt behalten die Reihenfolge der Ereignisse bei; eine fehlgeschlagene Zustellung wird mit wachsenden Pausen wiederholt.
Neue Ereignistypen und neue Felder können jederzeit hinzukommen: Überspringen Sie Typen und Felder, die Sie nicht kennen.