Docs

Docs

x-cpod-domain: integrations

Integrations

External system connections, data source registry, and sync state tracking for monitoring cross-app data pipeline health.

Try in explorer client.integrations.connections · client.integrations.dataSources · client.integrations.syncState

Connection

An external system connection (OAuth, API key, webhook).

REST path/api/v1/integrations/connections
Operations
listgetcreateupdatedelete
SDK
// list — returns only your records; add filters/search:
await client.integrations.connections.connections.list()

// create:
await client.integrations.connections.connections.create({
  name: "example name",
  provider: "example provider",
  id: "rec_01HXEXAMPLE",
  status: "active",
  auth_type: "oauth2",
  connected_at: "2026-01-01T00:00:00Z",
})
FieldTypeDescription
iduuid
name*string
provider*string
statusenumactiveinactiveerrorpending
auth_typeenumoauth2api_keybasicwebhook
connected_atdate-time

IntegrationDataSource

A registered data source with metadata.

REST path/api/v1/integrations/data-sources
Operations
listgetcreateupdatedelete
SDK
// list — returns only your records; add filters/search:
await client.integrations.connections.dataSources.list()

// create:
await client.integrations.connections.dataSources.create({
  name: "example name",
  id: "rec_01HXEXAMPLE",
  connection_id: "connection_01HXEXAMPLE",
  type: "example type",
  last_synced_at: "2026-01-01T00:00:00Z",
})
FieldTypeDescription
iduuid
connection_iduuidConnection
name*string
typestring
schemajson
last_synced_atdate-time

SyncState

Sync status and last-refresh timestamps for a data source.

REST path/api/v1/integrations/sync-state
Operations
listgetcreateupdate
SDK
// list — returns only your records; add filters/search:
await client.integrations.connections.syncState.list()

// create:
await client.integrations.connections.syncState.create({
  id: "rec_01HXEXAMPLE",
  data_source_id: "integrationdatasource_01HXEXAMPLE",
  status: "idle",
  last_refresh: "2026-01-01T00:00:00Z",
  records_synced: 42,
  error_message: "example error_message",
})
FieldTypeDescription
iduuid
data_source_iduuidIntegrationDataSource
statusenumidlesyncingsuccessfailed
last_refreshdate-time
records_syncedinteger
error_messagestring