Run Source Connection

1 from airweave import AirweaveSDK 2 3 client = AirweaveSDK( 4 api_key="YOUR_API_KEY", 5 ) 6 client.source_connections.run_source_connection( 7 source_connection_id="source_connection_id", 8 )

1 { 2 "source_connection_id": "source_connection_id", 3 "id": "id", 4 "organization_id": "organization_id", 5 "created_by_email": "created_by_email", 6 "modified_by_email": "modified_by_email", 7 "created_at": "2024-01-15T09:30:00Z", 8 "modified_at": "2024-01-15T09:30:00Z", 9 "status": "pending", 10 "entities_inserted": 1, 11 "entities_updated": 1, 12 "entities_deleted": 1, 13 "entities_kept": 1, 14 "entities_skipped": 1, 15 "entities_encountered": { 16 "key": 1 17 }, 18 "started_at": "2024-01-15T09:30:00Z", 19 "completed_at": "2024-01-15T09:30:00Z", 20 "failed_at": "2024-01-15T09:30:00Z", 21 "error": "error" 22 }

Trigger a sync run for a source connection.

Args: db: The database session source_connection_id: The ID of the source connection to run user: The current user background_tasks: Background tasks for async operations

Returns: The created sync job

Path parameters

source_connection_idstringRequired

Response

Successful Response

source_connection_idstringformat: "uuid"

idstringformat: "uuid"

organization_idstringformat: "uuid"

created_by_emailstringformat: "email"

modified_by_emailstringformat: "email"

created_atdatetime

modified_atdatetime

statusenumOptional

Sync job status enum.

Allowed values:

entities_insertedintegerOptional

entities_updatedintegerOptional

entities_deletedintegerOptional

entities_keptintegerOptional

entities_skippedintegerOptional

entities_encounteredmap from strings to optional integersOptional

started_atdatetimeOptional

completed_atdatetimeOptional

failed_atdatetimeOptional

errorstringOptional

Run Source Connection

Path parameters

Headers

Response

Errors