Sự kiện · Nguồn và nhập dữ liệu
import.document_failed
Nhập tài liệu thất bại
Một tài liệu của nguồn tùy chỉnh không được nhập hoặc không được lập chỉ mục (data.reason là một mã trung tính).
- Loại đối tượng
- source
- Gửi tới
- Webhook có vai trò admin
Payload
Đối tượng: EventImportDocumentFailed
idstringbắt buộcID sự kiện (
evt_…), cũng được gửi trong headerwebhook-id. Dùng nó để loại bỏ các lần gửi trùng lặp.typestringbắt buộcGiá trị cho phép:
import.document_failedcreated_atstring (date-time)bắt buộcThời điểm xảy ra thay đổi (UTC).
org_idintegerbắt buộcapi_versionstringbắt buộcPhiên bản hợp đồng của lược đồ
data.sequenceintegerSố thứ tự lần gửi trong phạm vi webhook (không có với sự kiện thử).
payloadstringbắt buộcthinnghĩa là không códata: hãy đọc đối tượng qua API.Giá trị cho phép:
fullthindataobjectTrường
documentobjectbắt buộcTài liệu của nguồn tùy chỉnh; kết quả tài liệu trong API đẩy dữ liệu báo cùng kết quả này.
Trường
external_idstring | nullbắt buộctitlestring | nullcard_idstring | nullbắt buộc
run_idintegerjob_idinteger | nullTác vụ lập chỉ mục hoặc tác vụ xuất.
reasonstringbắt buộcMã lý do trung tính (tập giá trị có thể mở rộng: hãy coi mã không xác định là lỗi chung). Giá trị là các mã kết quả của tài liệu:
content_invalid,file_rejected,too_large,limit_reached,index_failed.
testbooleanbắt buộcSự kiện thử được gửi bằng
POST /v1/webhooks/{webhook_id}/test.
Ví dụ một lần gửi
{
"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
}Nhận sự kiện
Mỗi lần gửi là một yêu cầu POST với phần thân JSON này tới webhook của bạn. Xác minh header webhook-signature (Standard Webhooks) trước khi tin vào phần thân, trả lời bằng trạng thái 2xx trong vài giây và xử lý công việc sau đó. Các lần gửi tới một webhook giữ đúng thứ tự sự kiện; lần gửi thất bại được thử lại với khoảng chờ tăng dần.
Loại sự kiện mới và trường mới có thể xuất hiện bất cứ lúc nào: hãy bỏ qua các loại và trường bạn không biết.
Các sự kiện này cũng có trong nguồn cấp sự kiện trong 30 ngày →