Skip to main content
POST
`POST /orgs/{org_id}/connectors/{connector_id}/syncs/{sync_id}/run`

Authorizations

Authorization
string
header
required

Timbal API key. Obtain your API key from the Timbal platform settings. See Authentication for more information.

Path Parameters

org_id
string
required
connector_id
string
required
sync_id
string
required

Response

Run dispatched (dispatched: true) or queued for the instance holding the connector's socket (dispatched: false)

dispatched
boolean
required

true: a run left for the connector on this request; job_id is set. false: the connector's socket lives on another control-plane instance (or the box is briefly offline), so the run was queued instead — the instance holding the socket dispatches it on its next scheduler tick (~30s), or on reconnect.

sync_id
string
required
job_id
string | null

The dispatched run's ConnectorJobs id — poll it via the jobs routes. null when the run was queued (dispatched: false); the queued run's job appears at the top of recent_runs once it fires.