Configurations

Understand sync configurations and how to manage them in Codeless Sync.

Updated: 15 Dec 2025

Configurations

A configuration defines a sync rule from an API provider to your PostgreSQL database. It specifies what data to sync, from where, and to which table.

Configuration Components

Each configuration includes:

  • Name - Descriptive identifier (e.g., "Production Customers")
  • Provider - Data source (Stripe, Shopify, PayPal, etc.)
  • Data Type - What to sync (customers, invoices, etc.)
  • Project - Which database project to use
  • Table Name - Target table in your database
  • API Key - Provider API key for access (restricted key recommended for Stripe)

Creating a Configuration

Use the 5-step wizard to create a new configuration:

  1. Select Provider & Type - Choose your provider and data type
  2. Select Project - Connect to your database project
  3. Enter API Key - Provide your provider API key
  4. Create Table - Auto-create or manually execute SQL in your database
  5. Review & Create - Name and save your configuration

See the Quick Start Guide for detailed step-by-step instructions.

Configuration Status

Configurations have an active toggle:

  • Active - Can be synced (manually or scheduled)
  • Inactive - Sync buttons disabled, schedules paused

Available Data Types

Available Data Types

  • Customers - Customer records (Stripe)
  • Invoices - Invoice data and line items
  • Subscriptions - Recurring subscription info
  • Payment Intents - Payment attempt records
  • Charges - Completed charge records
  • Products - Product catalog items
  • Prices - Pricing information

Additional providers like Shopify and PayPal are coming soon! Each provider will have its own data types available.

Managing Configurations

Edit a Configuration

You can update:

  • Configuration name
  • Active status
  • Provider API key

You cannot change:

  • Provider or data type
  • Target project or table
  • (Create a new configuration instead)

Delete a Configuration

Deleting a configuration:

  • ✅ Removes the configuration from Codeless Sync (CLS)
  • ✅ Deletes associated schedules
  • ❌ Does NOT delete your database table
  • ❌ Does NOT delete synced data

Best Practices

Naming Conventions

Use clear, descriptive names:

  • ✅ "Production Customers - Live"
  • ✅ "Test Invoices - Sandbox"
  • ❌ "Config 1"
  • ❌ "Test"

Environment Separation

Create separate configurations for:

  • Development (test mode keys)
  • Staging (test mode keys)
  • Production (live mode keys)

Security

  • Use restricted keys (rk_test_ or rk_live_) for Stripe - recommended by Stripe for third-party integrations
  • Secret keys (sk_test_ or sk_live_) are supported but not recommended for third-party services
  • Use test mode keys for development
  • Use live mode keys for production only
  • Rotate API keys regularly
  • Never share your configurations

Next Steps