Skip to main content
POST
Create Integration Source

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Model for creating a new integration source.

name
string
required

Display name for the integration source

source_type
enum<string>
required

Type of source (database or saas)

Available options:
database,
saas
connector_type
string
required

Specific connector type (e.g., postgresql, mysql, hubspot)

organization_id
string<uuid>
required

Organization that owns this integration source

description
string | null

Optional description for the integration source

is_system
boolean
default:false

Whether this is a system-managed source (e.g., Athena backing store)

is_sync
boolean
default:false

Whether this is an Airbyte-backed sync connector

configuration
Configuration · object

Non-sensitive configuration data

capabilities
string[]

List of capabilities supported by this source

is_active
boolean
default:true

Whether this integration source is active

connection_status
enum<string>
default:unknown

Current connection status

Available options:
connected,
disconnected,
error,
unknown
last_connection_test
string<date-time> | null

Timestamp of last connection test

legacy_data_source_id
string<uuid> | null

ID of the legacy data source this integration source was migrated from

system_source_id
string<uuid> | null

ID of the backing system source (e.g., Athena) for introspection routing

instance_label
string | null

Short label for tool name disambiguation (e.g., 'US', 'CA'). Forced uppercase. Required when multiple instances of the same connector type exist.

Maximum string length: 20
airbyte_source_id
string | null

Airbyte Cloud source ID

airbyte_connection_id
string | null

Airbyte Cloud connection ID

airbyte_connection_ids
string[] | null

Airbyte Cloud connection IDs (one per stream group)

airbyte_destination_id
string | null

Org-specific Airbyte destination ID

last_sync_at
string<date-time> | null

Last successful Airbyte sync time

last_sync_status
string | null

Airbyte sync status: success, failed, running, auth_required, configuring

last_sync_row_count
integer | null

Rows synced in last Airbyte job

selected_streams
string[] | null

User-selected stream names to sync. None = sync all (backward compat).

description_source
enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:
ai_generated,
manual_edit,
imported,
information_schema
description_generated_at
string<date-time> | null

When description was last modified

Response

Successful Response

Response model for integration sources (excludes sensitive data).

name
string
required

Display name for the integration source

source_type
enum<string>
required

Type of source (database or saas)

Available options:
database,
saas
connector_type
string
required

Specific connector type (e.g., postgresql, mysql, hubspot)

organization_id
string<uuid>
required

Organization that owns this integration source

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description_version
integer
required
description
string | null

Optional description for the integration source

is_system
boolean
default:false

Whether this is a system-managed source (e.g., Athena backing store)

is_sync
boolean
default:false

Whether this is an Airbyte-backed sync connector

configuration
Configuration · object

Non-sensitive configuration data

capabilities
string[]

List of capabilities supported by this source

is_active
boolean
default:true

Whether this integration source is active

connection_status
enum<string>
default:unknown

Current connection status

Available options:
connected,
disconnected,
error,
unknown
last_connection_test
string<date-time> | null

Timestamp of last connection test

legacy_data_source_id
string<uuid> | null

ID of the legacy data source this integration source was migrated from

system_source_id
string<uuid> | null

ID of the backing system source (e.g., Athena) for introspection routing

instance_label
string | null

Short label for tool name disambiguation (e.g., 'US', 'CA'). Forced uppercase. Required when multiple instances of the same connector type exist.

Maximum string length: 20
airbyte_source_id
string | null

Airbyte Cloud source ID

airbyte_connection_id
string | null

Airbyte Cloud connection ID

airbyte_connection_ids
string[] | null

Airbyte Cloud connection IDs (one per stream group)

airbyte_destination_id
string | null

Org-specific Airbyte destination ID

last_sync_at
string<date-time> | null

Last successful Airbyte sync time

last_sync_status
string | null

Airbyte sync status: success, failed, running, auth_required, configuring

last_sync_row_count
integer | null

Rows synced in last Airbyte job

selected_streams
string[] | null

User-selected stream names to sync. None = sync all (backward compat).

description_source
enum<string> | null

How description was created: 'ai_generated' | 'manual_edit' | 'imported' | 'information_schema'

Available options:
ai_generated,
manual_edit,
imported,
information_schema
description_generated_at
string<date-time> | null

When description was last modified