Przejdź do treści
Sursa Developers

Zdarzenia · Źródła i import

import.document_failed

Nie udało się zaimportować dokumentu

Dokument własnego źródła nie został zaimportowany lub zindeksowany (data.reason to kod neutralny).

Typ obiektu
source
Odbiorcy
Webhooki z rolą administratora

Treść zdarzenia

Obiekt: EventImportDocumentFailed

  • idstringwymagane

    ID zdarzenia (evt_…), wysyłany także jako nagłówek webhook-id. Używaj go do odrzucania zduplikowanych dostarczeń.

  • typestringwymagane

    Dozwolone wartości: import.document_failed

  • created_atstring (date-time)wymagane

    Kiedy nastąpiła zmiana (UTC).

  • org_idintegerwymagane
  • api_versionstringwymagane

    Wersja kontraktu schematu data.

  • sequenceinteger

    Numer kolejny dostarczenia w obrębie webhooka (brak dla zdarzenia testowego).

  • objectWebhookEventObjectwymagane
  • payloadstringwymagane

    thin oznacza brak data: odczytaj obiekt przez API.

    Dozwolone wartości: fullthin

  • dataobject
    Pola
    • sourceEventSourcewymagane
    • documentobjectwymagane

      Dokument własnego źródła; wynik dokumentu w API push podaje ten sam rezultat.

      Pola
      • external_idstring | nullwymagane
      • titlestring | null
      • card_idstring | nullwymagane
    • run_idinteger
    • job_idinteger | null

      Zadanie indeksowania lub eksportu.

    • reasonstringwymagane

      Kod neutralny przyczyny (wyliczenie rozszerzalne: nieznany kod traktuj jako ogólne niepowodzenie). Wartości to kody wyniku dokumentu: content_invalid, file_rejected, too_large, limit_reached, index_failed.

  • testbooleanwymagane

    Zdarzenie testowe wysłane przez POST /v1/webhooks/{webhook_id}/test.

Przykładowe dostarczenie

{
  "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
}

Odbieranie zdarzeń

Każde dostarczenie to żądanie POST z tą treścią JSON wysyłane na adres odbiorcy Twojego webhooka. Zanim zaufasz treści, zweryfikuj nagłówek webhook-signature (Standard Webhooks), odpowiedz statusem 2xx w ciągu kilku sekund, a właściwą pracę wykonaj później. Dostarczenia do jednego webhooka zachowują kolejność zdarzeń; nieudane dostarczenie jest ponawiane z coraz dłuższymi przerwami.

Nowe typy zdarzeń i nowe pola mogą pojawić się w każdej chwili: pomijaj typy i pola, których nie znasz.

Te same zdarzenia są dostępne w kanale zdarzeń przez 30 dni →