Įvykiai · Šaltiniai ir importas
import.document_failed
Importo dokumentas nepavyko
Pasirinktinio šaltinio dokumentas neimportuotas arba nesuindeksuotas (data.reason – neutralus kodas).
- Objekto tipas
- source
- Kam pristatoma
- Galiniams taškams su vaidmeniu admin
Turinys
Objektas: EventImportDocumentFailed
idstringprivalomasĮvykio ID (
evt_…), taip pat siunčiamas antraštėjewebhook-id. Naudokite jį pristatymų dublikatams atmesti.typestringprivalomasLeidžiamos reikšmės:
import.document_failedcreated_atstring (date-time)privalomasKada įvyko pakeitimas (UTC).
org_idintegerprivalomasapi_versionstringprivalomasdataschemos kontrakto versija.sequenceintegerPristatymo eilės numeris galiniame taške (bandomajam įvykiui jo nėra).
payloadstringprivalomasthinreiškia, kaddatanėra: objektą perskaitykite per API.Leidžiamos reikšmės:
fullthindataobjectLaukai
documentobjectprivalomasPasirinktinio šaltinio dokumentas; push API dokumento rezultatas praneša tą pačią baigtį.
Laukai
external_idstring | nullprivalomastitlestring | nullcard_idstring | nullprivalomas
run_idintegerjob_idinteger | nullIndeksavimo arba eksporto darbas.
reasonstringprivalomasNeutralus priežasties kodas (plečiamas išvardijimas: nežinomą kodą laikykite bendra nesėkme). Reikšmės – dokumento baigties kodai:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanprivalomasBandomasis įvykis, išsiųstas per
POST /v1/webhooks/{webhook_id}/test.
Pristatymo pavyzdys
{
"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
}Įvykių gavimas
Kiekvienas pristatymas – POST užklausa su šiuo JSON turiniu jūsų galiniam taškui. Pirmiausia patikrinkite antraštės webhook-signature parašą (Standard Webhooks) ir tik tada pasitikėkite turiniu, per kelias sekundes atsakykite 2xx būsena, o darbą atlikite vėliau. Pristatymai vienam galiniam taškui išlaiko įvykių tvarką; nepavykęs pristatymas kartojamas vis ilgesnėmis pauzėmis.
Nauji įvykių tipai ir nauji laukai gali atsirasti bet kada: nežinomus tipus ir laukus praleiskite.