chkit Sync (beta)

chkit Sync is a beta toolkit for syncing business app data into ClickHouse for analytics, reporting, and queries across apps.

Sync business app data
into ClickHouse.

Bring CRM records, conversations, meetings, outreach, and issue data into tables you can query together with SQL. Install an integration, configure credentials, and run a sync from your own project.

Choose an integration Run your first sync

Business apps Destination

• Attio
• Slack
• Circleback
• GitHub
• Google Calendar
• Google Meet
• lemlist
• Linear

chkit Sync Sync API records

ClickHouse Query with SQL

Business app APIs → chkit Sync → ClickHouse

Apps you can sync

Start with Attio, Slack, Circleback, GitHub, Google Calendar, Google Meet, lemlist, or Linear. Each guide lists the records it syncs, required permissions, and its coverage limits.

The integrations copy editable TypeScript schemas, API readers, and pipelines into the project. Change the source to select records, shape destination tables, or add another API.

How it works

1. Install an integration. Use chkit add to copy a provider template into the project, then configure the app credentials and ClickHouse connection.
2. Prepare the tables. chkit Schema defines destination tables and generates reviewable migrations. Apply them before the first sync.
3. Run and repeat. chkit ingest pulls API records, writes them to ClickHouse, and saves checkpoints after successful writes. Schedule recurring runs through cron, CI, or an existing scheduler.

Sync uses the @chkit/plugin-ingest package and the chkit ingest command.

Each run is a finite API pull. Checkpoints support incremental syncs and recovery; destination keys and versioning handle replayed rows. Record coverage and deletion behavior vary by integration.

Get started

Goal	Start here
Sync a business app	Apps & integrations and provider templates
Run a first sync	Sync quickstart with a small public API
Build a custom API source	Readers and pagination
Understand streams and checkpoints	API sync model

Operate your syncs

Use destinations and transformations to shape tables and incremental syncs to track source progress. Loading and batching covers writes; testing a source covers checkpoint behavior with fixtures.

Scheduling and recovery covers stream selection, execution budgets, retries, historical syncs, and journal diagnostics. chkit executes each run once; the scheduler determines when the next run starts.

Next

• Apps & integrations: choose an app and follow its setup guide.
• Sync quickstart: install the beta packages and run a first source.
• Sync CLI: template and stream commands.
• Sync plugin reference: TypeScript configuration and APIs.
• Publish a registry: distribute custom provider templates.