Run Sync

Trigger a sync run.

Args:

db: The database session sync_id: The ID of the sync to run user: The current user background_tasks: The background tasks

sync_job (schemas.SyncJob): The sync job

sync_idstringRequired

Successful Response

sync_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_detectedintegerOptional

entities_insertedintegerOptional

entities_deletedintegerOptional

entities_skippedintegerOptional

errorstringOptional

started_atdatetimeOptional

completed_atdatetimeOptional

failed_atdatetimeOptional

sync_namestringOptional

Name of the sync, populated from join query

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.sync.run_sync(
7	sync_id="sync_id",
8	)

1	{
2	"sync_id": "sync_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_detected": 1,
11	"entities_inserted": 1,
12	"entities_deleted": 1,
13	"entities_skipped": 1,
14	"error": "error",
15	"started_at": "2024-01-15T09:30:00Z",
16	"completed_at": "2024-01-15T09:30:00Z",
17	"failed_at": "2024-01-15T09:30:00Z",
18	"sync_name": "sync_name"
19	}