Sign in
Sync

Unified sync status for one connection

get/workspaces/{workspaceSlug}/connections/{connectionId}/sync

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
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

connectionIdinteger required

Response

OK

backfillSupportedboolean required

Whether this kind's runner offers an explicitly triggerable backfill pass. Reflects the vendor capability only — the scheduled-backfill flag does not gate it, so a manual backfill stays available while the automatic cycle is administratively paused.

connectionIdinteger required

Connection id

connectionState'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'UNINSTALLED' required

Raw connection lifecycle state

health'PENDING' | 'HEALTHY' | 'DEGRADED' | 'FAILED' | 'SUSPENDED' required

Derived health

kind'GITHUB' | 'GITLAB' | 'SLACK' | 'OUTLINE' required

Integration kind

lastEventProcessedAtstring date-time

When the last inbound webhook/event was processed for this connection, if any

lastSuccessfulSyncAtstring date-time

Most recent successful job's finish time

nextScheduledSyncAtstring date-time

When the next periodic reconciliation is expected

syncIntervalSecondsinteger

The periodic reconciliation's cadence in seconds, when the schedule has a regular one. This is what makes a resource's lastSyncedAt judgeable: "synced 4h ago" is only stale if the cadence is hourly, and a client cannot know that without this. Null when the schedule is irregular or unparseable — clients must then decline to judge staleness rather than assume a default, exactly as the server's own stale rollup does.

webhookRegisteredboolean

Whether the vendor webhook registration is present; null if not applicable/unknown

Changes

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