get-connector-sync

Read the status of a connector sync that sync-connector started or joined. Pass the sync_id it returned.

A sync does two things, and the status reports them separately, because they end at different times and one of them cannot always report its end:

It refreshes the connector's actions and ontology inside Wexa. status says how that went.
It starts ingestion, when the connector has data to pull. ingestion says what is known about the data.

Read status: "succeeded" as "the refresh succeeded". It does not mean that the data is in.

The two parts

status is one of:

`status`	Meaning
`running`	The refresh is still running.
`succeeded`	The connector's actions and ontology were refreshed.
`failed`	The refresh failed. `error` carries the reason the platform recorded.

A sync is failed when its workflow failed or ended early, when the connector failed to sync, or when the sync found no connector with that id in the project. It is never succeeded without having synced the connector.

ingestion is one of:

`ingestion`	Meaning
`not_started`	No ingestion was started yet. It stays so while the refresh runs, and when the refresh failed.
`started`	Ingestion was started, and no data is being pulled right now. A native connector also shows this after its pull ends, because the platform does not record when the pulled data has all reached the context graph.
`running`	Data is moving into the context graph.
`ingested`	The platform recorded that ingestion finished after this sync started.
`not_supported`	The sync started no ingestion, because the connector has no data to pull. Only its actions and ontology were refreshed.

ingested appears only for a data source ingested through the catalog pipeline, such as a database. A native connector, such as Linear or Slack, reports running while its data is pulled and started after the pull ends. The platform does not record when the pulled data has all reached the context graph, so it never reports ingested.

What it is called on each surface

The wire name is get-connector-sync everywhere: it is what the Wexa MCP server advertises, the REST path is POST /v1/get-connector-sync, and each SDK exposes it under its own language's naming convention.

Surface	Name
Wexa MCP server	`get-connector-sync`
REST API	`POST /v1/get-connector-sync`
TypeScript SDK	`fabric.getConnectorSync()`
Python SDK	`fabric.get_connector_sync()`

Arguments

Argument	Type	Required	Notes
`sync_id`	string	Required	The sync_id that sync-connector returned.

A sync_id names its project and its connector. One from another project, or for a connector you cannot sync, is refused before the platform is asked about it.

project_id, projectID, organization_id and executed_by are not arguments you pass: the platform binds all four from the credential you authenticated with, and both SDKs refuse them before the request leaves your process — see server-bound arguments.

What it returns

Field	What it is
`sync_id`	The sync you asked about.
`connector_id`	The connector being synced.
`status`	`running`, `succeeded` or `failed`, as above.
`ingestion`	`not_started`, `started`, `running`, `ingested` or `not_supported`, as above.
`actions_synced`	How many of the connector's actions the refresh synced.
`error`	Present only when `status` is `failed`.

The three surfaces wrap this differently, and code written against one will not read another correctly — see return shape.

A real response, captured from a live call to get-connector-sync after a sync of a Linear connector ended. The refresh succeeded and synced 17 actions, and its data was still moving. Nothing is changed.

{
  "content": [
    {
      "type": "text",
      "text": "{\"lifecycle_id\":\"qlc_000010\",\"result\":{\"sync_id\":\"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253\",\"connector_id\":\"6ab3608bf19beb4f0ed39e77\",\"status\":\"succeeded\",\"ingestion\":\"running\",\"actions_synced\":17}}"
    }
  ],
  "isError": false
}

{
  "lifecycle_id": "qlc_000010",
  "result": {
    "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
    "connector_id": "6ab3608bf19beb4f0ed39e77",
    "status": "succeeded",
    "ingestion": "running",
    "actions_synced": 17
  }
}

// the object you get back IS the result — there is no `.result` to read
{
  "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
  "connector_id": "6ab3608bf19beb4f0ed39e77",
  "status": "succeeded",
  "ingestion": "running",
  "actions_synced": 17
}

// The TS SDK names these camelCase — lifecycleId, traceId — where Python uses
// lifecycle_id and trace_id. Both are non-enumerable: readable, but omitted by
// Object.keys() and JSON.stringify(). `result.lifecycleId` here is undefined.
result.lifecycleId // 'qlc_000010'

# a dict subclass; `result` is already unwrapped
{
 "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
 "connector_id": "6ab3608bf19beb4f0ed39e77",
 "status": "succeeded",
 "ingestion": "running",
 "actions_synced": 17
}

out.lifecycle_id  # 'qlc_000010' — an attribute, not a key

Keeping the lifecycle_id is what lets you ask later why a call was allowed, refused or held.

Calling it

The same call on all four surfaces. Pick a tab once and every code block in the documentation follows it.

The ids in this example are real, and resolve against the project the documentation is written against. Swap them for your own. A value in angle brackets is one only you can supply, and the platform refuses a literal <...>.

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get-connector-sync",
    "arguments": {
      "sync_id": "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253"
    }
  }
}

curl -sS https://fabric.wexa.ai/v1/get-connector-sync \
  -H "authorization: Bearer $FABRIC_API_KEY" \
  -H "content-type: application/json" \
  -d '{"sync_id":"connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253"}'

import { Fabric } from '@wexa-fabric/sdk'

const fabric = new Fabric()
const status = await fabric.getConnectorSync({
  sync_id: "connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253"
})

from wexa import Fabric

fabric = Fabric()
status = fabric.get_connector_sync(
    sync_id="connector-sync-6aa9beb7ec8121a43b6c791b-6ab3608bf19beb4f0ed39e77-1790280549835063253",
)

Errors

Both SDKs raise the same typed errors, chosen from the gateway's own error string first and its HTTP status second. get-connector-sync checks the fabric:orchestrate.read grant, and reaches the seven classes every tool reaches — listed under the common set. These are the ones specific to it:

Error	Status	Raised when
`ForbiddenError`	403	The `sync_id` is not a sync of a connector you can sync in this project (`S8:connector-not-usable`).
`NotFound`	404	No sync with this `sync_id` exists (`S8:connector-sync-not-found`).
`ValidationError`	422	`sync_id` is missing or is not a string.

A failed sync is not an error. It comes back as a status with status: "failed".

Governance

Every call to get-connector-sync runs through the same ten-stage lifecycle as every other Wexa tool: the credential is resolved to a scope, the fabric:orchestrate.read grant is checked, quota is drawn down, the arguments are validated, policy rules are evaluated, the call is executed, the result is shaped and redacted, and an audit record is written. The lifecycle_id in the response is the handle to that record.

Reading a status needs only fabric:orchestrate.read, so a key that watches syncs does not need the power to start them.