Quick Start Guide

This guide walks you through creating your first sync configuration to synchronize api data with your PostgreSQL database.

Prerequisites

Before you begin, make sure you have:

• ✅ A PostgreSQL database (Supabase, Neon, or other provider)
• ✅ Your database connection string - see setup guide
• ✅ An API provider account (Stripe, Shopify, PayPal, etc.) with API access
• ✅ Your provider API key ready

Starting the Configuration Wizard

1. Log in to your Codeless Sync (CLS) dashboard at /dashboard
2. Click the Create Sync Configuration button
3. The 5-step configuration wizard will open

The Configuration Wizard

Step 1: Select Provider & Data Type

Choose which service and what type of data you want to sync.

1. Provider: Select your API provider (currently supports Stripe, with Shopify and PayPal coming soon)
2. Data Type: Choose what to sync (e.g., Customers)
3. Click Next to continue

Step 2: Connect Your Database

Select or create a connection to the PostgreSQL database you want to sync data into.

1. If you already added a project: Select it from the dropdown
2. If this is your first time: Click New Project to connect your database
   • You'll need your Connection String (e.g., postgresql://user:password@host:port/database)
   • Don't know where to find this? See our Database Setup Guide
3. Click Next to continue

Step 3: Enter Provider API Key

Connect your API provider account by entering your API key.

1. Paste your provider API key (for Stripe: restricted key recommended, format rk_test_ or rk_live_)
2. Click Test Connection to validate the key
3. Wait for the green checkmark indicating success
4. Click Next to continue

Step 4: Create Database Table

CLS can auto-create tables in your PostgreSQL database with one click. If auto-create fails, you can manually create the table using the SQL template provided.

Option A: Auto-Create (Recommended)

1. Click the Auto-Create Table button in the wizard
2. CLS will create the table with the correct schema
3. Click Verify Table to confirm, then click Next

Option B: Manual Creation

1. Copy the SQL template shown in the wizard
2. Open your database provider's SQL editor
3. Paste the SQL template and execute it
4. Return to the CLS wizard
5. Click Verify Table to confirm the table exists
6. Once verified, click Next to continue

Example SQL Template (for Stripe Customers):

CREATE TABLE stripe_customers (
  id TEXT PRIMARY KEY,
  email TEXT,
  name TEXT,
  created BIGINT,
  description TEXT,
  metadata JSONB,
  synced_at TIMESTAMPTZ DEFAULT NOW()
);

Step 5: Name & Review Configuration

Give your configuration a name and review your settings.

1. Enter a configuration name (e.g., "Production Customers" or "Test Invoices")
2. Review all your settings:
   • Provider and data type
   • Database project
   • Table name
3. Click Create Configuration to finish

Running Your First Sync

After creating your configuration, you're ready to run your first sync!

1. You'll be redirected to your dashboard
2. Find your newly created configuration
3. Click the Sync Now button
4. Monitor the progress indicator
5. Wait for the sync to complete (you'll see a success message)

What Happens During a Sync?

• Fetch: CLS requests data from your provider's API using your key
• Process: Data is processed in batches for efficiency
• Upsert: Records are inserted or updated in your database table
• Track: Progress updates show batch completion as syncing occurs

Verifying the Sync

Check that your provider data is now in your database:

1. Go to your database provider's dashboard
2. Select your project
3. Open the Table Editor or run a SQL query
4. Find your table (e.g., stripe_customers)
5. Verify that your provider data appears in the table

You should see rows of data matching what's in your provider account!

What's Next?

Congratulations! You've successfully created your first sync configuration. Here are some next steps:

Sync More Data Types

Create additional configurations to sync other provider data types:

• Invoices - Billing and invoice data
• Subscriptions - Recurring subscription information
• Payment Intents - Payment attempt records
• Charges - Completed payment charges
• Products - Product catalog
• Prices - Pricing information

Explore Your Configurations

• View sync history to track past syncs
• Toggle configurations active/inactive
• Edit configuration names
• Delete configurations you no longer need

Learn More

• Core Concepts - Understand how CLS works
• Projects Guide - Manage multiple database projects
• Configurations Guide - Advanced configuration options
• Troubleshooting - Common issues and solutions

Troubleshooting

Sync Failed

If your sync fails:

• ✅ Check that your provider API key is still valid
• ✅ Verify your table structure matches the SQL template
• ✅ Review the error message in the sync history
• ✅ Ensure the API key hasn't been deleted or revoked by your provider

No Data Appears

If no data appears in your database table:

• ✅ Verify you have data in your provider account for the selected data type
• ✅ Check that your provider API key is valid and hasn't been revoked
• ✅ Ensure the table was created successfully in your database
• ✅ Look for error messages in the sync history

Table Verification Failed

If the wizard can't verify your table:

• ✅ Make sure you executed the SQL template exactly as provided
• ✅ Check that the table name matches what you entered in the wizard
• ✅ Verify your database connection string is correct - see setup guide
• ✅ Ensure the table is in the public schema

Need More Help?

Visit our Troubleshooting Guide for detailed solutions to common issues.