本文へスキップ
Sursa Developers

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

export.ready

エクスポートの準備ができた

エクスポートファイルのダウンロードの準備ができました:カードのエクスポート、組織のエクスポート、または再生成されたファイルです。

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

ペイロード

オブジェクト:EventExportReady

  • idstring必須

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

  • typestring必須

    指定できる値: export.ready

  • created_atstring (date-time)必須

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

  • org_idinteger必須
  • api_versionstring必須

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

  • sequenceinteger

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

  • objectWebhookEventObject必須
  • payloadstring必須

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

    指定できる値: fullthin

  • dataobject
    フィールド
    • fileEventFile必須
    • kindstring必須

      エクスポートされたもの:cards、answer、card、report、org…

    • job_idinteger | null

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

    • actor_idinteger | null必須

      操作を実行したユーザー。組織のAPIキーまたはプラットフォーム自体の場合はnull。

    • regeneratedboolean

      ファイルが再作成されました(POST /v1/files/{file_id}/regenerate)。

  • testboolean必須

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

配信の例

{
  "id": "evt_0123456789abcdef0123456789abcdef",
  "type": "export.ready",
  "created_at": "2026-10-24T10:00:03Z",
  "org_id": 1,
  "api_version": "1.62.0",
  "sequence": 1042,
  "object": {
    "type": "file",
    "id": "f2b1c0de-0000-4000-8000-000000000001"
  },
  "payload": "full",
  "data": {
    "file": {
      "id": "f2b1c0de-0000-4000-8000-000000000001",
      "filename": "cards.xlsx",
      "format": "xlsx",
      "size": 18234,
      "expires_at": "2026-10-31T10:00:00Z"
    },
    "kind": "cards",
    "job_id": null,
    "actor_id": 7
  },
  "test": false
}

イベントの受信

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

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

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