Live Exports

Create a live export

Pick the source and destination connectors. An api_key connector may include auth inline (validated before anything persists); an oauth connector comes back unconnected with a pending action a person finishes in the browser. The export starts as a resumable draft.

post/v1/live-export/live-exports

Request

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

Request body

namestring

Defaults to "<Source> to <Destination>".

Example request

{
  "name": "HubSpot to Notion",
  "source": {
    "connector": "hubspot",
    "auth": {
      "apiKey": "pat-…"
    }
  },
  "destination": {
    "connector": "hubspot",
    "auth": {
      "apiKey": "pat-…"
    }
  }
}

Response

The new draft live export.

idstring required
namestring required
status'draft' | 'active' | 'manual_only' required

draft = not yet saved (no pipeline exists). After the first save: active = the schedule is on, manual_only = it is off and the export runs only when triggered.

unsaved_changesboolean required

True when mappings were edited over the API after the last save — trigger would run the last-applied pipeline, not the edits. Save to clear it. (An edit saved in the app clears it on the next save poll.)

created_atstring date-time required
app_urlstring uri required

The export in the Whalesync app — a convenience link, never a required step (anything that needs a person arrives as a pending action).

urlstring uri required
status_urlstring uri required
mappings_urlstring uri required

The working mappings document — edit, then save.

save_urlstring uri required

The save saga: POST to apply the mappings, GET to poll.

schedule_urlstring uri required

The on/off switch and cadence.

runs_urlstring uri required

The run history, pre-filtered to this export.

Example response

{
  "id": "lex_8f3kq0vz",
  "name": "HubSpot to Notion",
  "source": {
    "connector": "hubspot",
    "location": {
      "name": "CRM Exports"
    }
  },
  "destination": {
    "connector": "hubspot",
    "location": {
      "name": "CRM Exports"
    }
  },
  "schedule": {
    "time_of_day": "09:00",
    "timezone": "America/New_York"
  },
  "last_run": {
    "id": "run_8f3kq0vz.2mv91xk"
  },
  "pending_actions": [
    {
      "connector": "airtable"
    }
  ]
}

Changes

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