Към съдържанието
Sursa Developers

Събития · Източници и импорт

import.document_failed

Импортът на документ е неуспешен

Документ от собствен източник не е импортиран или не е индексиран (data.reason е неутрален код).

Тип на обекта
source
Получатели
Уебхуковете с ролята admin

Тяло на доставката

Обект: EventImportDocumentFailed

  • idstringзадължително

    ID на събитието (evt_…), изпраща се и като заглавката webhook-id. Използвайте го, за да отхвърляте дублираните доставки.

  • typestringзадължително

    Допустими стойности: import.document_failed

  • created_atstring (date-time)задължително

    Кога е настъпила промяната (UTC).

  • org_idintegerзадължително
  • api_versionstringзадължително

    Версия на API, на която отговаря схемата data.

  • sequenceinteger

    Пореден номер на доставката в рамките на уебхука (липсва при тестово събитие).

  • objectWebhookEventObjectзадължително
  • payloadstringзадължително

    thin означава без data: прочетете обекта чрез API.

    Допустими стойности: fullthin

  • dataobject
    Полета
    • sourceEventSourceзадължително
    • documentobjectзадължително

      Документът от собствения източник; резултатът за документа в API за изпращане (push) съобщава същия изход.

      Полета
      • external_idstring | nullзадължително
      • titlestring | null
      • card_idstring | nullзадължително
    • run_idinteger
    • job_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 до няколко секунди и свършете работата след това. Доставките към един уебхук запазват реда на събитията; неуспешната доставка се повтаря с нарастващи паузи.

Нови типове събития и нови полета може да се появят по всяко време: пропускайте типовете и полетата, които не познавате.

Същите събития се пазят 30 дни в лентата със събития →