Operation API

Refresh shared state, inspect asynchronous results, and cancel eligible uncommitted Connector work.

Use the shared request contract for authentication, pagination, preconditions, idempotency, and common errors. Exact response members are defined in API data types and the downloadable OpenAPI contract.

Synchronize a connection

POST/api/v1/connector/organizations/{organization_id}/connections/{connection_id}/synchronizations

Scope: sync:write
Auth: Bearer API key
Repeat calls: Organization-scoped Idempotency-Key; 24 hours

Refreshes permitted present state for every active direction.

Requires Idempotency-Key.

Requires an active connection; otherwise returns 409 connection_inactive. Success includes all selected directions.

A partial refresh returns a failed result with affected resource keys; inspect source references before repeating the task. Synchronization does not reconstruct expired event history.

Request body

reasonstringrequired

Audited reason; empty values are rejected.

rule1–2000 characters

202Accepted

Returns operation.id for operation polling and request_id; acceptance does not establish completion.

Read an operation

GET/api/v1/connector/organizations/{organization_id}/operations/{operation_id}

Scope: operations:read
Auth: Bearer API key

Returns acknowledged progress, result references, and recovery detail.

reconciling means the outcome is unknown. Keep the original ID and restore its connection before submitting replacement work. A terminal failure does not roll back completed source effects.

200Result

Returns data as Operation, plus request_id.

Cancel an operation

POST/api/v1/connector/organizations/{organization_id}/operations/{operation_id}/cancel

Scope: connections:write
Auth: Bearer API key
Repeat calls: Organization-scoped Idempotency-Key; 24 hours

Requests cancellation of uncommitted Connector work.

Requires If-Match from a current read. Requires Idempotency-Key.

Requires cancelable: true; otherwise returns 409 not_cancelable. Poll to a terminal result. Cancellation does not undo delivered copies or cancel linked native product operations.