Create Source Connection

Create a new source connection.

This endpoint creates:

An integration credential with the provided auth fields
A collection if not provided
The source connection
A sync configuration and DAG
A sync job if immediate execution is requested

Args: db: The database session source_connection_in: The source connection to create user: The current user background_tasks: Background tasks for async operations

Returns: The created source connection

Request

This endpoint expects an object.

namestringRequired>=4 characters<=42 characters

Name of the source connection

short_namestringRequired

descriptionstringOptional

config_fieldsmap from strings to anyOptional

Config values model.

Implements “flat dictionary” semantics, where no values are dictionaries.

collectionstringOptional

cron_schedulestringOptional

auth_fieldsmap from strings to anyOptional

Config values model.

Implements “flat dictionary” semantics, where no values are dictionaries.

sync_immediatelybooleanOptionalDefaults to true

Response

Successful Response

namestring>=4 characters<=42 characters

Name of the source connection

short_namestring

idstringformat: "uuid"

organization_idstringformat: "uuid"

created_atdatetime

modified_atdatetime

collectionstring

created_by_emailstringformat: "email"

modified_by_emailstringformat: "email"

descriptionstringOptional

config_fieldsmap from strings to anyOptional

Config values model.

Implements “flat dictionary” semantics, where no values are dictionaries.

sync_idstringOptionalformat: "uuid"

connection_idstringOptionalformat: "uuid"

auth_fieldsmap from strings to any or stringOptional

statusenumOptional

Source connection status enum.

Allowed values:

latest_sync_job_statusenumOptional

Sync job status enum.

Allowed values:

latest_sync_job_idstringOptionalformat: "uuid"

latest_sync_job_started_atdatetimeOptional

latest_sync_job_completed_atdatetimeOptional

cron_schedulestringOptional

next_scheduled_rundatetimeOptional

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.source_connections.create_source_connection(
7	name="name",
8	short_name="short_name",
9	)

1	{
2	"name": "name",
3	"short_name": "short_name",
4	"id": "id",
5	"organization_id": "organization_id",
6	"created_at": "2024-01-15T09:30:00Z",
7	"modified_at": "2024-01-15T09:30:00Z",
8	"collection": "collection",
9	"created_by_email": "created_by_email",
10	"modified_by_email": "modified_by_email",
11	"description": "description",
12	"config_fields": {
13	"key": "value"
14	},
15	"sync_id": "sync_id",
16	"connection_id": "connection_id",
17	"auth_fields": {
18	"key": "value"
19	},
20	"status": "active",
21	"latest_sync_job_status": "pending",
22	"latest_sync_job_id": "latest_sync_job_id",
23	"latest_sync_job_started_at": "2024-01-15T09:30:00Z",
24	"latest_sync_job_completed_at": "2024-01-15T09:30:00Z",
25	"cron_schedule": "cron_schedule",
26	"next_scheduled_run": "2024-01-15T09:30:00Z"
27	}

Create Source Connection

Headers

Request

Response

Errors