Mine sisu juurde
Sursa Developers

Sündmused · Allikad ja import

import.document_failed

Dokumendi import nurjus

Kohandatud allika dokumenti ei imporditud või ei indekseeritud (data.reason on neutraalne kood).

Objekti tüüp
source
Vastuvõtvad veebihaagid
Veebihaagid, millel on roll admin

Sisu

Objekt: EventImportDocumentFailed

  • idstringkohustuslik

    Sündmuse ID (evt_…), mis saadetakse ka päisena webhook-id. Kasutage seda topeltedastuste kõrvaldamiseks.

  • typestringkohustuslik

    Lubatud väärtused: import.document_failed

  • created_atstring (date-time)kohustuslik

    Millal muudatus toimus (UTC).

  • org_idintegerkohustuslik
  • api_versionstringkohustuslik

    Skeemi data lepingu versioon.

  • sequenceinteger

    Edastuse järjekorranumber veebihaagi piires (testsündmuse puhul puudub).

  • objectWebhookEventObjectkohustuslik
  • payloadstringkohustuslik

    thin tähendab, et välja data ei ole: lugege objekti API kaudu.

    Lubatud väärtused: fullthin

  • dataobject
    Väljad
    • sourceEventSourcekohustuslik
    • documentobjectkohustuslik

      Kohandatud allika dokument; push-API dokumendi tulemus teatab sama tulemuse.

      Väljad
      • external_idstring | nullkohustuslik
      • titlestring | null
      • card_idstring | nullkohustuslik
    • run_idinteger
    • job_idinteger | null

      Indekseerimis- või eksporditöö.

    • reasonstringkohustuslik

      Neutraalne põhjuse kood (laiendatav loend: käsitlege tundmatut koodi üldise tõrkena). Väärtused on dokumendi tulemuse koodid: content_invalid, file_rejected, too_large, limit_reached, index_failed.

  • testbooleankohustuslik

    Testsündmus, mille saatis POST /v1/webhooks/{webhook_id}/test.

Näidisedastus

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

Sündmuste vastuvõtmine

Iga edastus on selle JSON-kehaga POST-päring teie veebihaagi URL-ile. Enne keha usaldamist kontrollige päist webhook-signature (Standard Webhooks), vastake mõne sekundi jooksul olekuga 2xx ja tehke töö ära hiljem. Ühe veebihaagi edastused säilitavad sündmuste järjekorra; ebaõnnestunud edastust proovitakse uuesti üha pikemate vahedega.

Uued sündmusetüübid ja uued väljad võivad ilmuda igal ajal: jätke tundmatud tüübid ja väljad vahele.

Samad sündmused on 30 päeva jooksul sündmuste lindis →