Whalesync

Everything known about one record's sync state — the diagnosis tool for "why isn't this record syncing". Returns open issues blocking it, a pending delete awaiting a person's review, operations queued right now, per-side flags (deleted / filtered out by a sync filter / sync disabled), links to the record in both apps, and its most recent operations. queued_operations null means the queue could not be consulted, not that it is empty. For older history call sync_list_operations with record. Diagnose from the flags and issues before assuming the sync itself is broken: a filtered or sync-disabled record is excluded on purpose, and a pending delete waits for a person to approve it in the app.

sync_get_record_status

Full sync details: status, both sides, open issue count, review_url, and pending_actions. When pending_actions is non-empty, relay each action's url and instruction to the person verbatim — those steps (browser sign-in, reviewing before starting) can only be done by a human.

sync_get

One issue in full, including its remediation.

sync_get_issue

One operation in full, including per-field changes.

sync_get_operation

The working mappings document: which source tables copy into which to-be-created destination tables, field by field. Carries the revision to send back on live_export_update_mappings.

live_export_get_mappings

The live view: whether a run is in flight right now, and when the next scheduled run fires.

live_export_get_status

A live snapshot: pending pushes and each side's polling/initializing state. Makes live calls, so it can take a few seconds — use sync_get for the cheap summary.

sync_get_status

The sync's declarative mappings document plus its revision. Keep the revision and send it back with sync_update_mappings so a concurrent edit fails instead of being silently overwritten. Also the place to find a table pair's sync filter and advanced settings when asked why some records never sync.

sync_get_mappings

The bases/sites/databases the credential on one side can reach, fetched live from the connected app (can take a few seconds). Reference a base by its remote id — names are not unique.

sync_list_bases

The tables on one side of the sync, from Whalesync's cached schema (fetched automatically the first time). Pass refresh: true after changing the connected app's schema; refresh requires the sync to be off. May block for up to a minute while a fetch completes.

sync_list_tables

The fields of one table with type metadata, from the cached schema. Reference the table by table_… id, remote id, or exact name — resolution tries them in that order, so when the same string names tables on both sides (Postgres remote ids are bare table names), pass side to pin which one you mean. May block for up to a minute while a fetch completes. When choosing what to map: fields with write: false (formulas, created-time, Whalesync's synthesized record id, …) can only be the SOURCE side of a one-way mapping — include them only when the person wants that value in the other app (syncing a record id across is a common, legitimate case). Skip fields whose type_details.mapping_disabled is true, and map link/reference fields only when the table they point at is also mapped.

sync_list_fields

Every connector Whalesync supports, with its auth method (API key fields vs browser OAuth) and capabilities. Start here to learn what a sync side needs.

sync_list_connectors

Where the destination can host created tables (an Airtable base, a Notion parent page). Pick one with live_export_update. Only destinations with pickable locations return any.

live_export_list_locations

The connectors usable for live exports, each with the roles it can play (source, destination) and its auth. A separate registry from sync_list_connectors — the same brand can differ per surface.

live_export_list_connectors

One export's recent runs, newest first — the monitoring surface (live exports have runs, not issues; a failed run's error is the diagnostic). History is retention-bounded.

live_export_list_runs

The account's live exports, newest first. Paginate with cursor when has_more is true.

live_export_list

Open issues on one sync, each with a remediation hint. Empty means healthy.

sync_list_issues

The record-level change log for one sync, newest first: what was created, updated, or deleted, where, and why. The place to verify a sync is actually moving data.

sync_list_operations

Deletes waiting on a person for one sync. When a record goes missing on one side, Whalesync holds the delete rather than applying it to the other side, so an accidental delete or an app outage cannot destroy data. Each entry links to the record in the connected app so a person can look before deciding. Approving or ignoring is irreversible and deliberately not in this API — relay the entry's review_url. A sync that auto-approves deletes has no queue and answers delete_approval_disabled; sync_get reports which mode a sync is in before you call.

sync_list_pending_deletes

One source table's exportable fields, each with the name and type it would get in the destination. Pick from these when writing mappings — field types are planned by the server, never chosen by you.

live_export_list_source_fields

The exportable tables in the source app. Live — the connector enumerates them, so it can be slow.

live_export_list_source_tables

The account's syncs, newest first. Paginate with cursor when has_more is true.

sync_list

Turns an active sync off. Mappings can only be edited while paused.

sync_pause

Declarative full replace of the mappings document. Edits the working draft only — nothing is created in the destination until live_export_save. The document: {"tables": [{"source_table", "destination_table": {"create": {"name"}}, "fields": [{"source_field", "destination_field": {"create": {"name", "primary?"}}}]}]}. Reference source tables/fields by the ids the list tools return. Send back the revision you read — a stale revision fails instead of overwriting someone's edit.

live_export_update_mappings

Replaces the whole mappings document (fetch with sync_get_mappings, modify, send back — there is no partial edit). Validate first with sync_validate_mappings. Referenced tables whose fields were never fetched are fetched during the call, so a first update can take a few seconds. The sync must be paused or draft.

sync_update_mappings

Re-attempts the failed work behind an issue. Fix the cause (see remediation) first.

sync_retry_issue

Create the mapped tables and fields in the destination app, then apply the runnable pipeline. This is the apply point: mapping edits change nothing until a save lands. The call stays on the line while the save runs (usually well under a minute), streaming progress; a still-running result says to call live_export_get_save for the outcome. succeeded is authoritative — it also requires unsaved_changes to be false on the export. Runs overwrite the destination tables this export manages — treat destination data as replaceable before pointing an export at anything a person cares about.

live_export_save

Find a record in one sync by its id in the connected app (e.g. an Airtable "rec…" id), its Whalesync rec_… id, or its display text (fuzzy). The first step when a person asks why a specific record is not syncing — take a result's id to sync_get_record_status. Exact id matches come first. Results are capped, not paginated: when has_more is true, narrow the query.

sync_search_records

Run the export now, regardless of the schedule. One run at a time — a trigger while one is active returns run_in_progress. Unsaved mapping edits return the unsaved_changes conflict (the run would use the last-saved pipeline, not them): live_export_save first, or — only if the person explicitly wants the old pipeline — pass force. Runs overwrite the destination tables this export manages — treat destination data as replaceable before pointing an export at anything a person cares about.

live_export_trigger

Rename it, complete an api_key side's withheld auth, or set the destination's location (where created tables live, from live_export_list_locations).

live_export_update

Turn the export on or off and set its cadence. Creates the schedule on first use; missing fields keep their current values. Requires a saved export. Runs overwrite the destination tables this export manages — treat destination data as replaceable before pointing an export at anything a person cares about.

live_export_update_schedule

Rename the sync, amend a draft side, or update credentials.

sync_update

The checks live_export_update_mappings would run, as a report instead of a rejection.

live_export_validate_mappings

Checks a candidate mappings document (or the stored one, if tables is omitted) without changing anything. Empty issues means valid. Can take a few seconds if referenced tables need a schema fetch.

sync_validate_mappings

Reports where a sync is in the setup flow and the recommended next steps, including any action only a person can do (relay those verbatim). Call it with no arguments to get oriented, or whenever unsure.

sync_whats_next

The happy-path compass for live exports: given where an export actually is, the ordered next steps — including the browser connection steps only a person can do (relay those verbatim). Call it with no arguments to get oriented, or whenever unsure.

live_export_whats_next