Notikumi · Avoti un imports
import.document_failed
Dokumenta imports neizdevās
Pielāgota avota dokuments netika importēts vai indeksēts (data.reason ir neitrāls kods).
- Objekta tips
- source
- Kam piegādā
- Galapunktiem ar administratora lomu
Saturs
Objekts: EventImportDocumentFailed
idstringobligātsNotikuma ID (
evt_…), tiek sūtīts arī kā galvenewebhook-id. Izmantojiet to, lai atmestu dublētas piegādes.typestringobligātsAtļautās vērtības:
import.document_failedcreated_atstring (date-time)obligātsKad notika izmaiņas (UTC).
org_idintegerobligātsapi_versionstringobligātsdatashēmas līguma versija.sequenceintegerPiegādes kārtas numurs galapunktā (testa notikumam nav).
payloadstringobligātsthinnozīmē, kadatanav: nolasiet objektu caur API.Atļautās vērtības:
fullthindataobjectLauki
documentobjectobligātsPielāgotā avota dokuments; push API dokumenta rezultāts ziņo par to pašu iznākumu.
Lauki
external_idstring | nullobligātstitlestring | nullcard_idstring | nullobligāts
run_idintegerjob_idinteger | nullIndeksēšanas vai eksporta darbs.
reasonstringobligātsNeitrāls iemesla kods (paplašināms uzskaitījums: nezināmu kodu uzskatiet par vispārīgu kļūmi). Vērtības ir dokumentu iznākuma kodi:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanobligātsTesta notikums, ko nosūta
POST /v1/webhooks/{webhook_id}/test.
Piegādes piemērs
{
"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
}Notikumu saņemšana
Katra piegāde ir POST pieprasījums ar šo JSON saturu uz jūsu galapunktu. Pirms uzticaties saturam, pārbaudiet galvenes webhook-signature parakstu (Standard Webhooks), dažu sekunžu laikā atbildiet ar 2xx statusu un darbu veiciet pēc tam. Piegādes vienam galapunktam saglabā notikumu secību; neizdevusies piegāde tiek atkārtota ar pieaugošām pauzēm.
Jauni notikumu tipi un jauni lauki var parādīties jebkurā laikā: tipus un laukus, ko nepazīstat, izlaidiet.