Event Reference

All events delivered on the exports:{uuid} channel follow the standard event envelope. Events on notification and dashboard channels use a typed message format.

Export Job Events

These events are delivered on the exports:{uuid} channel and export.{guid}.job channel.

job.created

Fired when a new export job is created and enters the processing queue.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.created",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "queueing",
  "url": null,
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "queueing",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}

job.progress

Fired periodically as the export processes items. Throttled to at most one event every 5 seconds per job.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.progress",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "progress",
  "url": null,
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "progress",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "totalExported": 678,
    "total": 1500
  },
  "current": 678,
  "total": 1500
}

job.finished

Fired when the export completes successfully. The url field contains the download link.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.finished",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "done",
  "url": "https://exportcomments.com/download/export-b4219d47.xlsx",
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "done",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "totalExported": 1500,
    "total": 1500,
    "download_link": "https://exportcomments.com/download/export-b4219d47.xlsx",
    "json_url": "https://exportcomments.com/download/export-b4219d47.json"
  }
}

job.failed

Fired when the export encounters an unrecoverable error.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.failed",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "error",
  "url": null,
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "error",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
    "error": "Rate limited by platform"
  }
}

job.requeued

Fired when a failed export is requeued for another attempt.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.requeued",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "queueing",
  "url": null,
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "queueing",
    "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ"
  }
}

job.convert.done

Fired when file format conversion (e.g., JSON to XLSX) completes.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.convert.done",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "done",
  "url": "https://exportcomments.com/download/export-b4219d47.xlsx",
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "done"
  }
}

job.convert.failed

Fired when file format conversion fails.

Payload200

json

{
  "version": "v3-beta",
  "event": "job.convert.failed",
  "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
  "status": "error",
  "url": null,
  "details": {
    "guid": "b4219d47-3138-5efd-9762-2ef9f9495084",
    "status": "error"
  }
}

Webhook Events

Delivered on the webhooks:{uuid} channel.

webhook.event.created

Fired when a webhook delivery is attempted.

Payload200

json

{
  "version": "v3-beta",
  "event": "webhook.event.created",
  "guid": "a1b2c3d4-5678-9abc-def0-123456789abc",
  "status": "200",
  "url": null,
  "details": {
    "uuid": "a1b2c3d4-5678-9abc-def0-123456789abc",
    "event": "export.finished",
    "responseCode": "200",
    "webhookUrl": "https://yourapp.com/webhook"
  }
}

Account Events

Delivered on the user:{uuid} channel.

subscription.updated

Fired when your subscription plan changes.

Payload200

json

{
  "type": "subscription.updated",
  "plan": "business",
  "action": "created",
  "timestamp": 1705312200
}

The action field is one of: created, expired, canceled.

Bulk Download Events

Delivered on the exports:{uuid} channel.

bulk_download.ready

Fired when a bulk download ZIP file is assembled and ready.

Payload200

json

{
  "version": "v3-beta",
  "event": "bulk_download.ready",
  "guid": "d4e5f6a7-8901-bcde-f234-567890abcdef",
  "status": "ready",
  "url": "https://exportcomments.com/download/bulk-d4e5f6a7.zip"
}

bulk_download.failed

Fired when a bulk download ZIP assembly fails.

Payload200

json

{
  "version": "v3-beta",
  "event": "bulk_download.failed",
  "guid": "d4e5f6a7-8901-bcde-f234-567890abcdef",
  "status": "error",
  "url": null
}

Event Envelope Fields

All events on export channels include these fields:

Field	Type	Description
`version`	string	API version (`v3-beta`)
`event`	string	Event type identifier
`guid`	string	Export job or resource UUID
`status`	string	Current status of the resource
`url`	string\|null	Download URL (populated when files are ready)
`details`	object\|null	Full serialized entity data

Progress events include additional fields:

Field	Type	Description
`current`	integer	Number of items exported so far
`total`	integer	Total number of items to export