Skip to content
Sursa Developers

Events · Jobs and exports

export.ready

Export ready

An export file is ready to download: a card export, an organization export or a regenerated file.

Object type
file
Delivered to
Endpoints with the admin role

Payload

Object: EventExportReady

  • idstringrequired

    Event ID (evt_…), also sent as the webhook-id header. Use it to drop duplicate deliveries.

  • typestringrequired

    Allowed values: export.ready

  • created_atstring (date-time)required

    When the change happened (UTC).

  • org_idintegerrequired
  • api_versionstringrequired

    Contract version of the data schema.

  • sequenceinteger

    Delivery sequence number within the endpoint (absent for a test event).

  • objectWebhookEventObjectrequired
  • payloadstringrequired

    thin means no data: read the object through the API.

    Allowed values: fullthin

  • dataobject
    Fields
    • fileEventFilerequired
    • kindstringrequired

      What was exported: cards, answer, card, report, org …

    • job_idinteger | null

      The indexing or export job.

    • actor_idinteger | nullrequired

      The user who performed the action; null for an organization API key or the platform itself.

    • regeneratedboolean

      The file was rebuilt (POST /v1/files/{file_id}/regenerate).

  • testbooleanrequired

    A test event sent by POST /v1/webhooks/{webhook_id}/test.

Example delivery

{
  "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
}

Receiving events

Each delivery is a POST request with this JSON body to your endpoint. Verify the webhook-signature header (Standard Webhooks) before you trust the body, answer with a 2xx status within a few seconds, and do the work afterwards. Deliveries to one endpoint keep the order of events; a failed delivery is retried with growing pauses.

New event types and new fields can appear at any time: skip the types and fields you do not know.

The same events are in the event feed for 30 days →