Tapahtumat · Lähteet ja tuonti
import.document_failed
Tuonnin asiakirja epäonnistui
Mukautetun lähteen asiakirjaa ei tuotu tai sitä ei indeksoitu (data.reason on neutraali koodi).
- Objektin tyyppi
- source
- Vastaanottavat webhookit
- Webhookit, joilla on admin-rooli
Hyötykuorma
Objekti: EventImportDocumentFailed
idstringpakollinenTapahtuman tunnus (
evt_…), joka lähetetään myöswebhook-id-otsakkeena. Käytä sitä kaksoistoimitusten pudottamiseen.typestringpakollinenSallitut arvot:
import.document_failedcreated_atstring (date-time)pakollinenMilloin muutos tapahtui (UTC).
org_idintegerpakollinenapi_versionstringpakollinendata-skeeman sopimusversio.sequenceintegerToimituksen järjestysnumero webhookin sisällä (puuttuu testitapahtumalta).
payloadstringpakollinenthintarkoittaa, etteidata-kenttää ole: lue objekti API:n kautta.Sallitut arvot:
fullthindataobjectKentät
documentobjectpakollinenMukautetun lähteen asiakirja; push-API:n asiakirjakohtainen tulos kertoo saman lopputuloksen.
Kentät
external_idstring | nullpakollinentitlestring | nullcard_idstring | nullpakollinen
run_idintegerjob_idinteger | nullIndeksointi- tai vientityö.
reasonstringpakollinenNeutraali syykoodi (laajennettava luettelo: käsittele tuntematonta koodia yleisenä virheenä). Arvot ovat asiakirjan lopputuloksen koodeja:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanpakollinenPOST /v1/webhooks/{webhook_id}/test-toiminnon lähettämä testitapahtuma.
Esimerkkitoimitus
{
"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
}Tapahtumien vastaanottaminen
Jokainen toimitus on POST-pyyntö webhookisi URL-osoitteeseen, ja sen runkona on tämä JSON. Tarkista webhook-signature-otsake (Standard Webhooks) ennen kuin luotat runkoon, vastaa 2xx-tilalla muutaman sekunnin kuluessa ja tee varsinainen työ vasta sen jälkeen. Saman webhookin toimitukset säilyttävät tapahtumien järjestyksen; epäonnistunutta toimitusta yritetään uudelleen yhä pidemmin tauoin.
Uusia tapahtumatyyppejä ja uusia kenttiä voi ilmestyä milloin tahansa: ohita tyypit ja kentät, joita et tunne.