本文へスキップ
Sursa Developers

イベント · ソースとインポート

import.document_failed

ドキュメントのインポートに失敗した

カスタムソースのドキュメントがインポートされなかったか、インデックスが作成されませんでした(data.reasonは中立的なコード)。

オブジェクトの種類
source
配信先
adminロールのWebhook

ペイロード

オブジェクト:EventImportDocumentFailed

  • idstring必須

    イベントのID(evt_…)。webhook-idヘッダーとしても送信されます。重複した配信を破棄するために使ってください。

  • typestring必須

    指定できる値: import.document_failed

  • created_atstring (date-time)必須

    変更が発生した日時(UTC)。

  • org_idinteger必須
  • api_versionstring必須

    dataスキーマの契約のバージョン。

  • sequenceinteger

    Webhook内での配信の連番(テストイベントにはありません)。

  • objectWebhookEventObject必須
  • payloadstring必須

    thinはdataがないことを意味します:APIでオブジェクトを読み取ってください。

    指定できる値: fullthin

  • dataobject
    フィールド
    • sourceEventSource必須
    • documentobject必須

      カスタムソースのドキュメント。プッシュAPIのドキュメントの結果も同じ結果を返します。

      フィールド
      • external_idstring | null必須
      • titlestring | null
      • card_idstring | null必須
    • run_idinteger
    • job_idinteger | null

      インデックス作成ジョブまたはエクスポートジョブ。

    • reasonstring必須

      中立的な理由コード(値が増えうる列挙型:不明なコードは一般的な失敗として扱ってください)。値はドキュメントの結果コードです:content_invalid、file_rejected、too_large、limit_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
}

イベントの受信

各配信は、このJSONボディを持つPOSTリクエストとしてWebhookの受信先URLに送られます。ボディを信頼する前にwebhook-signatureヘッダー(Standard Webhooks)を検証し、数秒以内に2xxステータスで応答してから、処理を行ってください。1つのWebhookへの配信はイベントの順序を保ちます。失敗した配信は間隔を広げながら再試行されます。

新しいイベントタイプや新しいフィールドはいつでも追加されることがあります。知らないタイプとフィールドは無視してください。

同じイベントは30日間イベントフィードで確認できます →