Langsung ke konten
Sursa Developers

Peristiwa · Sumber dan impor

import.document_failed

Impor dokumen gagal

Sebuah dokumen sumber kustom tidak diimpor atau tidak diindeks (data.reason adalah kode netral).

Jenis objek
source
Dikirim ke
Webhook dengan peran admin

Payload

Objek: EventImportDocumentFailed

  • idstringwajib

    ID peristiwa (evt_…), juga dikirim sebagai header webhook-id. Gunakan untuk membuang pengiriman duplikat.

  • typestringwajib

    Nilai yang diizinkan: import.document_failed

  • created_atstring (date-time)wajib

    Kapan perubahan terjadi (UTC).

  • org_idintegerwajib
  • api_versionstringwajib

    Versi kontrak skema data.

  • sequenceinteger

    Nomor urut pengiriman dalam webhook (tidak ada untuk peristiwa uji).

  • payloadstringwajib

    thin berarti tanpa data: baca objek melalui API.

    Nilai yang diizinkan: fullthin

  • dataobject
    Field
    • sourceEventSourcewajib
    • documentobjectwajib

      Dokumen sumber kustom; hasil dokumen API push melaporkan hasil yang sama.

      Field
      • external_idstring | nullwajib
      • titlestring | null
      • card_idstring | nullwajib
    • run_idinteger
    • job_idinteger | null

      Job pengindeksan atau ekspor.

    • reasonstringwajib

      Kode alasan netral (enum yang dapat bertambah: perlakukan kode yang tidak dikenal sebagai kegagalan umum). Nilainya adalah kode hasil dokumen: content_invalid, file_rejected, too_large, limit_reached, index_failed.

  • testbooleanwajib

    Peristiwa uji yang dikirim oleh POST /v1/webhooks/{webhook_id}/test.

Contoh pengiriman

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

Menerima peristiwa

Setiap pengiriman adalah permintaan POST dengan isi JSON ini ke URL penerima webhook Anda. Periksa header webhook-signature (Standard Webhooks) sebelum Anda memercayai isinya, jawab dengan status 2xx dalam beberapa detik, lalu kerjakan prosesnya sesudahnya. Pengiriman ke satu webhook mempertahankan urutan peristiwa; pengiriman yang gagal dicoba ulang dengan jeda yang makin panjang.

Jenis peristiwa baru dan field baru dapat muncul kapan saja: lewati jenis dan field yang tidak Anda kenal.

Peristiwa yang sama tersedia di umpan peristiwa selama 30 hari →