Integrations Feature Documentation

Overview

The Integrations feature allows users to connect Lystica with popular email marketing platforms to sync campaigns, contacts, lists, and events. This enables seamless data flow between Lystica and other marketing tools.

Supported Platforms

Currently Supported

Features

Core Functionality

1. Add Integrations - Connect new platforms using API credentials
2. Manage Integrations - Edit, test, and delete existing integrations
3. Sync Data - Automatic and manual synchronization options
4. Connection Testing - Verify API credentials work correctly
5. Sync Settings - Granular control over what data to sync

Sync Options

• Contacts - Sync contact lists and subscriber data
• Campaigns - Sync email campaigns and their status
• Lists - Sync audience segments and groups
• Events - Sync engagement events (opens, clicks, etc.)

User Interface

Studio Dashboard Card

• Location: /dashboard/studio
• Card Display: Shows integration status and quick access
• Action: Links to integrations management page

Integrations Management Page

• Location: /dashboard/studio/integrations
• Features:
  • View all connected platforms
  • Add new integrations
  • Quick actions (test, sync, edit, delete)
  • Platform status indicators

Add Integration Page

• Location: /dashboard/studio/integrations/new?platform={platform}
• Features:
  • Platform-specific setup instructions
  • API credential input forms
  • Sync settings configuration
  • Links to platform documentation

Edit Integration Page

• Location: /dashboard/studio/integrations/{id}/edit
• Features:
  • Update API credentials
  • Modify sync settings
  • Test connection
  • Manual sync trigger
  • Activate/deactivate integration

Technical Implementation

Database Schema

integrations: {
  clerkUserId: Id<"clerkUsers">,
  platform: "omnisend" | "hubspot" | "mailchimp" | ...,
  platformName: string,
  apiKey?: string,
  apiSecret?: string,
  accessToken?: string,
  accountId?: string,
  webhookUrl?: string,
  isActive: boolean,
  isConnected: boolean,
  lastSyncAt?: number,
  syncEnabled: boolean,
  syncSettings: {
    syncContacts: boolean,
    syncCampaigns: boolean,
    syncLists: boolean,
    syncEvents: boolean,
  },
}

Setup Instructions

Best Practices

• Always test your integration after setup
• Start with manual sync before enabling automatic sync
• Monitor sync logs for any issues
• Keep your API credentials secure and up to date
• Review sync settings periodically to ensure they meet your needs
• Use webhooks when available for real-time sync

Troubleshooting