Eventi · Fonti e importazione
import.document_failed
Importazione di un documento non riuscita
Un documento di una fonte personalizzata non è stato importato o non è stato indicizzato (data.reason è un codice neutro).
- Tipo di oggetto
- source
- Consegnato a
- Webhook con il ruolo admin
Payload dell’evento
Oggetto: EventImportDocumentFailed
idstringobbligatorioID dell’evento (
evt_…), inviato anche come intestazionewebhook-id. Usalo per scartare le consegne duplicate.typestringobbligatorioValori ammessi:
import.document_failedcreated_atstring (date-time)obbligatorioMomento in cui è avvenuta la modifica (UTC).
org_idintegerobbligatorioapi_versionstringobbligatorioVersione del contratto dello schema di
data.sequenceintegerNumero progressivo della consegna all’interno del webhook (assente per un evento di test).
payloadstringobbligatoriothinindica che non c’èdata: leggi l’oggetto tramite l’API.Valori ammessi:
fullthindataobjectCampi
documentobjectobbligatorioIl documento della fonte personalizzata; il risultato del documento nell’API di invio riporta lo stesso esito.
Campi
external_idstring | nullobbligatoriotitlestring | nullcard_idstring | nullobbligatorio
run_idintegerjob_idinteger | nullIl job di indicizzazione o di esportazione.
reasonstringobbligatorioCodice neutro del motivo (enumerazione estendibile: tratta un codice sconosciuto come un errore generico). I valori sono i codici di esito dei documenti:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanobbligatorioUn evento di test inviato da
POST /v1/webhooks/{webhook_id}/test.
Esempio di consegna
{
"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
}Ricezione degli eventi
Ogni consegna è una richiesta POST con questo corpo JSON verso il tuo webhook. Verifica l’intestazione webhook-signature (Standard Webhooks) prima di fidarti del corpo, rispondi con uno stato 2xx entro pochi secondi ed esegui il lavoro dopo. Le consegne a uno stesso webhook mantengono l’ordine degli eventi; una consegna non riuscita viene ritentata con pause sempre più lunghe.
Nuovi tipi di evento e nuovi campi possono comparire in qualsiasi momento: ignora i tipi e i campi che non conosci.
Gli stessi eventi restano nel feed degli eventi per 30 giorni →