本文へスキップ
Sursa Developers

イベント · ジョブとエクスポート

job.failed

ジョブが失敗した

バックグラウンドジョブが失敗したか、キャンセルされました(data.reasonは中立的なコード)。

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

ペイロード

オブジェクト:EventJobFailed

  • idstring必須

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

  • typestring必須

    指定できる値: job.failed

  • created_atstring (date-time)必須

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

  • org_idinteger必須
  • api_versionstring必須

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

  • sequenceinteger

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

  • objectWebhookEventObject必須
  • payloadstring必須

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

    指定できる値: fullthin

  • dataobject
    フィールド
    • jobEventJob必須
    • reasonstring必須

      中立的な理由コード(値が増えうる列挙型:不明なコードは一般的な失敗として扱ってください)。例:canceled、timeout、unprocessable、internal。

  • testboolean必須

    POST /v1/webhooks/{webhook_id}/testで送信されたテストイベント。

配信の例

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "job.failed",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "job",
    "id": "4410"
  },
  "payload": "full",
  "data": {
    "job": {
      "id": 4410,
      "kind": "index",
      "status": "error",
      "card_id": "c_9f2e41",
      "collection": "support",
      "batch_id": null,
      "title": "Refund policy.pdf",
      "finished_at": "2026-10-24T10:00:03Z"
    },
    "reason": "timeout"
  },
  "test": false
}

イベントの受信

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

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

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