本文へスキップ
Sursa Developers

オブジェクト

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で送信されたテストイベント。

イベントのペイロード

import.document_failed