Live Exports

Trigger a run

Run the export now, regardless of the schedule. One run at a time: a trigger while one is active returns the run_in_progress conflict. Unsaved mapping edits return the unsaved_changes conflict — the run would use the last-saved pipeline, not them — save first, or send {"force": true} to run anyway. The run writes into the destination tables.

post/v1/live-export/live-exports/{id}/trigger

Request

  • Base URL: https://api.whalesync.com
  • URL: https://api.whalesync.com/v1/live-export/live-exports/{id}/trigger
  • Auth: HTTP bearer

Path parameters

idstring required
Example:lex_8f3kq0vz

Request body

forceboolean

Run even though the mappings have unsaved edits (the run uses the last-saved pipeline, not them). Without it, that state is the unsaved_changes conflict.

Response

The new (pending) run. Poll its url or …/status.

idstring required
status'pending' | 'running' | 'completed' | 'failed' | 'cancelled' required
trigger'manual' | 'schedule' required

Whether a person/API started it, or the cadence did.

started_atstring date-time nullable required
finished_atstring date-time nullable required
summarystring nullable required

The one-line story: what the run is doing right now, or how it ended.

warningstring nullable required

Set when the run completed but a step finished with a warning.

errorstring nullable required

The rolled-up error for a failed run.

app_urlstring uri required

The run in the Whalesync app, for a person who wants to watch or share it — like every app_url, nothing here needs their attention.

live_export_idstring required

The Live Export this run belongs to.

urlstring uri required

Example response

{
  "id": "run_8f3kq0vz.2mv91xk",
  "live_export_id": "lex_8f3kq0vz",
  "steps": [
    {
      "name": "Pull Contacts"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.