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 · client.integrations.microsoft.config · client.integrations.microsoft.connection · client.integrations.microsoft.calendar

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—
statusenum—activeinactiveerrorpending
auth_typeenum—oauth2api_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_iduuid→Connection—
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_iduuid→IntegrationDataSource—
statusenum—idlesyncingsuccessfailed
last_refreshdate-time—
records_syncedinteger—
error_messagestring—

MicrosoftConfig

Tenant-admin Azure app registration for Microsoft Calendar (client ID/secret stored encrypted).

REST path/api/v1/integrations/microsoft/config
Operations
putConfiggetConfig
SDK
// list — returns only your records; add filters/search:
await client.integrations.microsoft.config.list()
FieldTypeDescription
configuredboolean—
clientId*string—
clientSecret*string—
azureTenantIdstring—
updatedAtdate-time—

MicrosoftConnection

Per-user Microsoft OAuth connection — authorize, redeem the msConnect ticket, status, disconnect.

REST path/api/v1/integrations/microsoft/connection
Operations
getStatusgetAuthorizeUrlcompleteConnectiondisconnect
SDK
// list — returns only your records; add filters/search:
await client.integrations.microsoft.connection.list()
FieldTypeDescription
configuredboolean—
connectedboolean—
emailemail—
scopesjson—
connectedAtdate-time—
disconnectedAtdate-time—

MicrosoftCalendar

Microsoft Graph calendar broker — list, create, update, cancel, and respond to events.

REST path/api/v1/integrations/microsoft/calendar/events
Operations
listEventscreateEventupdateEventcancelEventrespondToEvent
SDK
// list — returns only your records; add filters/search:
await client.integrations.microsoft.calendar.list()
FieldTypeDescription
idstring—
subjectstring—
start*date-time—
end*date-time—
locationstring—
isOnlineMeetingboolean—
joinUrlstring—
attendeesjson—