Syncs API

Sync job execution and monitoring

The Syncs API allows you to trigger sync jobs, monitor their progress, and retrieve detailed logs and record-level events. Use this API to automate your data synchronization workflows.

Key Concepts

Sync Job - An execution of a mapping that transfers data between systems
Status - The current state of a sync job: pending, running, completed, failed, or cancelled
Dry Run - A simulation mode that shows what would be synced without actually modifying data
Sync Logs - Detailed logs of operations performed during a sync
Record Events - Per-record tracking of fetch, transform, and upsert operations

Triggering Syncs

You can trigger syncs immediately via the API, or configure scheduled syncs and webhooks through the mapping settings. The API supports both full syncs and dry runs for testing.

Syncs API

Sync job execution and monitoring

The Syncs API allows you to trigger sync jobs, monitor their progress, and retrieve detailed logs and record-level events. Use this API to automate your data synchronization workflows.

Key Concepts

Sync Job - An execution of a mapping that transfers data between systems
Status - The current state of a sync job: pending, running, completed, failed, or cancelled
Dry Run - A simulation mode that shows what would be synced without actually modifying data
Sync Logs - Detailed logs of operations performed during a sync
Record Events - Per-record tracking of fetch, transform, and upsert operations

Triggering Syncs

You can trigger syncs immediately via the API, or configure scheduled syncs and webhooks through the mapping settings. The API supports both full syncs and dry runs for testing.