Exports Operations
Why You Would Use This
Section titled “Why You Would Use This”Exports are asynchronous jobs. Understanding the lifecycle helps you automate reliably and set correct expectations for large date ranges.
Job Lifecycle
Section titled “Job Lifecycle”- Create export job.
- Poll job status (
pendingorprocessing). - Download when status is
completed. - Handle
failedandexpiredstates with retry or regeneration.
Console Workflow
Section titled “Console Workflow”- Start export from Messages with filters applied.
- Open Exports to monitor progress.
- Refresh or wait for automatic updates while jobs are active.
- Download completed files.
If export-ready email notifications are enabled for your deployment/user context, you may also receive an email when the export is complete.
API Workflow
Section titled “API Workflow”# Create exportcurl -X POST https://api.hookbridge.io/v1/exports \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "direction": "outbound", "start_time": "2026-02-01T00:00:00Z", "end_time": "2026-02-25T23:59:59Z", "status": "failed_permanent" }'
# List exportscurl https://api.hookbridge.io/v1/exports \ -H "Authorization: Bearer YOUR_API_KEY"
# Get export statuscurl https://api.hookbridge.io/v1/exports/YOUR_EXPORT_ID \ -H "Authorization: Bearer YOUR_API_KEY"
# Download exportcurl -L https://api.hookbridge.io/v1/exports/YOUR_EXPORT_ID/download \ -H "Authorization: Bearer YOUR_API_KEY" \ -o export.csv Personalize Examples
Enter your credentials to populate code examples throughout the docs.