อีเวนต์ · แหล่งข้อมูลและการนำเข้า
import.document_failed
นำเข้าเอกสารไม่สำเร็จ
เอกสารของแหล่งข้อมูลแบบกำหนดเองนำเข้าหรือทำดัชนีไม่สำเร็จ (data.reason เป็นรหัสกลาง)
- ประเภทออบเจ็กต์
- source
- ส่งถึง
- เว็บฮุกที่มีบทบาท admin
เพย์โหลด
ออบเจ็กต์: EventImportDocumentFailed
idstringจำเป็นID ของอีเวนต์ (
evt_…) ส่งเป็นเฮดเดอร์webhook-idด้วย ใช้ค่านี้เพื่อทิ้งการส่งที่ซ้ำtypestringจำเป็นค่าที่ใช้ได้:
import.document_failedcreated_atstring (date-time)จำเป็นเวลาที่เกิดการเปลี่ยนแปลง (UTC)
org_idintegerจำเป็นapi_versionstringจำเป็นเวอร์ชันของสัญญา API ของสคีมา
datasequenceintegerหมายเลขลำดับการส่งภายในเว็บฮุก (ไม่มีสำหรับอีเวนต์ทดสอบ)
payloadstringจำเป็นthinหมายถึงไม่มีdata: ให้อ่านออบเจ็กต์ผ่าน APIค่าที่ใช้ได้:
fullthindataobjectฟิลด์
documentobjectจำเป็นเอกสารของแหล่งข้อมูลแบบกำหนดเอง ผลของเอกสารใน API สำหรับส่ง (push) รายงานผลลัพธ์เดียวกัน
ฟิลด์
external_idstring | nullจำเป็นtitlestring | nullcard_idstring | nullจำเป็น
run_idintegerjob_idinteger | nullงานทำดัชนีหรืองานส่งออก
reasonstringจำเป็นรหัสกลางของเหตุผล (enum ที่อาจมีค่าเพิ่ม: ให้ถือว่ารหัสที่ไม่รู้จักเป็นความล้มเหลวทั่วไป) ค่าเป็นรหัสผลลัพธ์ของเอกสาร:
content_invalidfile_rejectedtoo_largelimit_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 ภายในไม่กี่วินาที แล้วจึงประมวลผลภายหลัง การส่งไปยังเว็บฮุกเดียวกันคงลำดับของอีเวนต์ไว้ และการส่งที่ล้มเหลวจะลองส่งใหม่โดยเว้นระยะนานขึ้นทุกครั้ง
อาจมีประเภทอีเวนต์ใหม่และฟิลด์ใหม่เพิ่มเข้ามาได้ทุกเมื่อ ให้ข้ามประเภทและฟิลด์ที่ไม่รู้จัก