События · Источники и импорт
import.document_failed
Документ импорта не обработан
Документ своего источника не импортирован или не проиндексирован (data.reason — нейтральный код).
- Тип объекта
- source
- Кому доставляется
- Вебхукам с ролью администратора
Тело доставки
Объект: EventImportDocumentFailed
idstringобязательноID события (
evt_…), передаётся также в заголовкеwebhook-id. По нему отбрасывайте повторные доставки.typestringобязательноДопустимые значения:
import.document_failedcreated_atstring (date-time)обязательноКогда произошло изменение (UTC).
org_idintegerобязательноapi_versionstringобязательноВерсия контракта схемы
data.sequenceintegerПорядковый номер доставки в пределах вебхука (нет у проверочного события).
payloadstringобязательноthin— безdata: читайте объект через API.Допустимые значения:
fullthindataobjectПоля
documentobjectобязательноДокумент своего источника; результат документа в push API сообщает тот же исход.
Поля
external_idstring | nullобязательноtitlestring | nullcard_idstring | nullобязательно
run_idintegerjob_idinteger | nullЗадание индексации или экспорта.
reasonstringобязательноНейтральный код причины (расширяемое перечисление: незнакомый код считайте общей ошибкой). Значения — коды результата документа:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanобязательноПроверочное событие, отправленное
POST /v1/webhooks/{webhook_id}/test.
Пример доставки
{
"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
}Получение событий
Каждая доставка — это POST-запрос с таким JSON-телом на адрес вашего вебхука. Прежде чем доверять телу, проверьте заголовок webhook-signature (Standard Webhooks), ответьте статусом 2xx в течение нескольких секунд, а саму работу выполняйте уже после ответа. Доставки на один адрес сохраняют порядок событий; неудачная доставка повторяется с нарастающими паузами.
Новые типы событий и новые поля могут появиться в любой момент: пропускайте типы и поля, которых не знаете.