Sign in
Sync

Trigger a manual sync or backfill

Trigger a manual sync. Idempotent-absorb: a connection that already has an active job answers 200 with that job rather than erroring, so a double-click "Sync now" is harmless.

post/workspaces/{workspaceSlug}/connections/{connectionId}/sync/jobs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/connections/{connectionId}/sync/jobs
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

connectionIdinteger required

Request body

type'INITIAL' | 'RECONCILIATION' | 'BACKFILL' required

RECONCILIATION for a full re-sync, BACKFILL for historical data

Response

Idempotent-absorb: a same-type job was already running and is returned unchanged

cancelRequestedboolean required

Whether a cooperative cancel was requested

createdAtstring date-time required

When the job row was created

errorSummarystring

Truncated error summary, set on FAILED

finishedAtstring date-time

When the job finished (any terminal status)

idinteger required

Job id

itemsProcessedinteger

Coarse progress: items processed so far

itemsTotalinteger

Coarse progress: total items, if known

progressobject

Per-phase progress detail, integration-specific shape

startedAtstring date-time

When the job started running

status'PENDING' | 'RUNNING' | 'SUCCEEDED' | 'SUCCEEDED_WITH_WARNINGS' | 'FAILED' | 'CANCELLED' required

Job status

trigger'SCHEDULED' | 'MANUAL' | 'LIFECYCLE' | 'SYSTEM' required

What initiated this job

triggeredByUserIdinteger

Account id of the admin who triggered this job, if MANUAL

type'INITIAL' | 'RECONCILIATION' | 'BACKFILL' required

What kind of pass this is

Changes

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