All docs

Core features

Module Deployment Guide

Learn how to deploy, configure, and manage modules in your Synton AI store.

Learn how to deploy, configure, and manage modules in your Synton AI store.

What You'll Learn

  • How to deploy modules through AI chat
  • Module installation methods
  • Configuration screens and settings
  • Activation, pausing, and removal
  • Troubleshooting common issues

Deploying Your First Module

Step 1: Choose a Module

First, decide which module you need. See Understanding Modules for a complete list.

Popular first modules:

  • Reviews - Build trust with customer feedback
  • Loyalty - Reward repeat customers
  • Chatbot - 24/7 customer support
  • Cart Recovery - Reduce abandonment

Step 2: Request Deployment via AI

Open the Chat tab and tell the AI which module you want:

I want to add a review system to my product pages

Or be more specific:

Deploy the reviews module to collect customer feedback

Step 3: Review Module Details

The AI will show you:

Module Information:

  • What the module does
  • Features included
  • Pricing (if not included in your plan)
  • Integration method

Example response:

The Reviews Module will:
✓ Send automated review request emails
✓ Display star ratings on product pages
✓ Moderate reviews with AI
✓ Show verified buyer badges

This module is included in your Professional plan.
Would you like to proceed with installation?

Step 4: Confirm Deployment

Type yes or confirm to proceed:

Yes, deploy the reviews module

Step 5: Choose Integration Method

The AI will ask how you want to integrate:

Option A: Auto-Install (Recommended)

The AI automatically adds code to your theme.

Pros:

  • Quick (30 seconds)
  • No technical knowledge needed
  • Works immediately

Cons:

  • Requires theme write permissions
You: Use auto-install
AI: Installing reviews module to your theme...
AI: ✓ Module code added to product.liquid
AI: ✓ Styles added to theme.css
AI: ✓ Background jobs scheduled
AI: ✓ Module is now live!

Option B: Manual Integration

The AI provides embed code for you to paste.

Pros:

  • Full control over placement
  • Works with locked themes

Cons:

  • Manual copy-paste required
  • Requires platform admin access
You: Give me manual embed code
AI: Here's the code to add to your product.liquid:

{%comment%} Synton Reviews {%endcomment%}
<div id="synton-reviews" data-product-id="{{ product.id }}"></div>
<script src="https://app.synton.ai/cdn/shop-{{ shop.id }}/widgets/reviews.js"></script>

Copy this code and paste it where you want reviews to appear.

Step 6: Configuration

After deployment, the AI provides a link to the module configuration page:

✓ Reviews module is live!

Configuration page: https://app.synton.ai/app/reviews

Click the link to customize settings.

Module Configuration Screens

Each module has a dedicated configuration page accessible from:

Dashboard → Click module name → Configure

Or via direct URL: https://app.synton.ai/app/[module-name]

Common Configuration Sections

Display Settings

Control how the module appears on your store:

Styling:

  • Primary color (buttons, highlights)
  • Secondary color (backgrounds)
  • Font family
  • Border radius (rounded corners)
  • Spacing and padding

Positioning:

  • Where to display (product page, cart, checkout)
  • Above or below existing content
  • Mobile vs desktop positioning

Visibility:

  • Show on all products or specific collections
  • Hide for certain customer segments
  • Display rules (only if condition met)

Example - Reviews Module:

Display Settings:
├── Position: Below product description
├── Max reviews shown: 10
├── Sort by: Most recent
├── Show rating summary: Yes
├── Star color: #FFD700 (gold)
└── Mobile layout: Stacked

Behavior Settings

Configure how the module functions:

Triggers:

  • When to activate (page load, scroll, click)
  • Delay timing
  • Frequency limits

Actions:

  • What happens on user interaction
  • Redirect behavior
  • Data collection

Automation:

  • Background job schedules
  • Email sending times
  • Auto-moderation rules

Example - Cart Recovery Module:

Behavior Settings:
├── First email: 1 hour after abandonment
├── Second email: 24 hours
├── Third email: 72 hours
├── Include discount: After 24 hours (10% off)
├── Stop if order completed: Yes
└── Max emails per customer: 3/month

Content Settings

Customize messages and text:

Labels and Headers:

  • Button text
  • Section titles
  • Call-to-action copy

Email Templates:

  • Subject lines
  • Body content
  • Footer disclaimers

Translations:

  • Multi-language support
  • Auto-detect customer language

Example - Loyalty Module:

Content Settings:
├── Points name: "Stars"
├── Welcome email subject: "Welcome to our VIP program!"
├── Point earned message: "You earned {points} Stars!"
├── Redemption button: "Redeem Your Stars"
└── Languages: English, Spanish, French

Integration Settings

Connect third-party services:

Email Services:

  • Sendgrid, Mailchimp, Klaviyo

Analytics:

  • Google Analytics, Meta Pixel

CRM:

  • HubSpot, Salesforce

Webhooks:

  • Custom endpoint URLs
  • Event triggers

Example - Chatbot Module:

Integration Settings:
├── Zendesk account: Connected ✓
├── Slack notifications: #customer-support
├── Webhook URL: https://yourdomain.com/webhook
└── Events: conversation_started, escalated

Performance Analytics

View module metrics:

Key Metrics:

  • Impressions (how many times shown)
  • Interactions (clicks, submissions)
  • Conversions (purchases, signups)
  • Revenue impact

Charts and Trends:

  • Daily/weekly/monthly views
  • Conversion rates over time
  • A/B test results

Export:

  • CSV download
  • API access

Installation Methods Explained

Auto-Install Process

When you choose auto-install:

  1. AI Reads Theme

    • Identifies theme structure
    • Finds optimal injection points
    • Checks for conflicts

  2. Code Generation

    • Creates theme-specific code
    • Matches your theme's style
    • Adds necessary scripts

  3. Theme Modification

    • Backs up current theme
    • Injects module code
    • Updates stylesheets

  4. Background Setup

    • Schedules jobs (if needed)
    • Configures webhooks
    • Initializes database records

  5. Verification

    • Tests module functionality
    • Confirms no errors
    • Provides configuration link

Time: 30-60 seconds

Manual Integration Process

When you choose manual integration:

  1. Get Embed Code

The AI provides:

<!-- Synton Reviews Widget -->
<div id="synton-reviews" data-product-id="{{ product.id }}"></div>
<script src="https://app.synton.ai/cdn/shop-YOUR_SHOP_ID/widgets/reviews.js"></script>
  1. Open Your Platform Admin
  • Shopify: Go to Admin → Online Store → Themes → Edit code
  • WooCommerce: Go to Appearance → Theme File Editor
  • Other platforms: Access your theme or template editor
  1. Find Injection Point

For reviews:

  • Open sections/product-template.liquid or sections/main-product.liquid
  • Find where you want reviews to appear
  • Usually below product description: {{ product.description }}
  1. Paste Code

Add the embed code:

<!-- Product Description -->
<div class="product-description">
  {{ product.description }}
</div>

<!-- Synton Reviews Widget -->
<div id="synton-reviews" data-product-id="{{ product.id }}"></div>
<script src="https://app.synton.ai/cdn/shop-YOUR_SHOP_ID/widgets/reviews.js"></script>
  1. Save and Preview
  • Click Save
  • Preview your store
  • Verify module appears correctly
  1. Complete Setup

Tell the AI you've added the code:

I've added the reviews widget to my theme

The AI completes background setup (jobs, webhooks).

Time: 5-10 minutes

Module Activation

After deployment, modules are automatically Active and running.

Active Status Means:

  • Module displays on your store
  • Background jobs are running (if applicable)
  • You're being charged for the module (if add-on)

Verify Activation:

  1. Go to Dashboard
  2. Check Active Modules section
  3. Look for green "Active" badge

Or ask the AI:

Show me my active modules

Module Configuration Best Practices

1. Customize Before Launch

Don't just deploy and forget:

  • Update colors to match your brand
  • Write custom copy (don't use defaults)
  • Test on mobile and desktop
  • Set appropriate triggers (don't be too aggressive)

2. Start Conservative

For behavior settings:

  • Start with longer delays (less intrusive)
  • Lower frequency limits
  • Test before increasing

Example - Popups:

  • ❌ Show immediately on page load
  • ✅ Show after 30 seconds or 50% scroll

3. Monitor Performance

Check analytics weekly:

  • Are users interacting?
  • What's the conversion rate?
  • Any negative feedback?

Adjust settings based on data.

4. A/B Test

Most modules support A/B testing:

Run an A/B test on my review display:
- Variant A: Show 5 reviews
- Variant B: Show 10 reviews
Test for 2 weeks

5. Keep Content Fresh

Update regularly:

  • Email templates (seasonal themes)
  • Popup messages (current promotions)
  • Chatbot FAQs (new products)

Pausing Modules

Temporarily disable without removing:

Via AI:

Pause the popups module for the holiday weekend

Via Dashboard:

  1. Go to module configuration
  2. Toggle Pause Module switch
  3. Confirm

What Happens:

  • Module stops displaying on store
  • Background jobs pause
  • Data is retained
  • Billing is unaffected (modules are included on every plan)

When to Pause:

  • During sales events (prevent distractions)
  • When making theme changes
  • For testing purposes
  • Temporarily disable features

Resume:

Resume the popups module

Or toggle back on in dashboard.

Removing Modules

Permanently uninstall:

Via AI:

Remove the bundles module from my store

Via Dashboard:

  1. Go to module configuration
  2. Click Remove Module (bottom of page)
  3. Read warning
  4. Type module name to confirm
  5. Click Confirm Removal

What Happens:

  • Module code removed from theme (if auto-installed)
  • Background jobs stopped and deleted
  • Configuration deleted
  • Historical data archived (30 days)
  • Module charge ends (on next billing cycle)
  • Module slot freed up

Warning:

⚠️ Removing a module is permanent!

Data will be archived for 30 days, then deleted.
This includes:
- All configuration
- Historical analytics
- Customer data (points, reviews, etc.)

Are you sure you want to remove the Reviews Module?
Type "Reviews" to confirm:

Reversibility:

Within 30 days:

Reinstall the reviews module with my previous settings

After 30 days:

  • Module can be reinstalled
  • Previous data is lost
  • Starts fresh

Managing Multiple Modules

View All Modules

Via AI:

Show me all my installed modules

Via Dashboard:

  • Go to Dashboard
  • See Active Modules widget
  • Click View All for detailed list

How Many Modules Can I Install?

As many as you like. Every module is included on every plan, including Free, with no per-module fee and no cap.

What varies by plan is your monthly allowance of AI credits, which only the AI-powered features inside a module consume. Configuration, storefront widgets and background jobs are free on every plan.

Check what's active:

Which modules do I have active?

Removing a module you don't use is still worth doing — every active module is one more thing to keep configured — but it doesn't free up a slot, because there are no slots.

Module Dependencies

Some modules work better together:

Loyalty + Reviews:

  • Award points for leaving reviews
  • Higher engagement

Chatbot + Cart Recovery:

  • Chatbot can answer cart questions
  • Recovery emails mention chatbot

Bundles + Upsells:

  • Show bundles as upsells
  • Maximize order value

The AI will suggest complementary modules:

You installed Reviews. Consider adding:
- Loyalty (reward customers for reviews)
- Social Proof (show recent reviews)
Would you like to learn more?

Troubleshooting

Module Not Appearing

Check:

  1. Module Status

    Is my reviews module active?

  2. Theme Integration

    • For manual installs, verify code is correct
    • Check you saved theme changes

  3. Display Rules

    • Module may be hidden by configuration
    • Check product/collection filters

  4. Cache

    • Clear browser cache
    • Wait 2-3 minutes for CDN propagation

  5. Conflicts

    • Other apps might conflict
    • Check browser console for errors

Fix:

Diagnose why my reviews module isn't showing

Module Not Working Correctly

Examples:

  • Reviews not submitting
  • Loyalty points not calculating
  • Emails not sending

Steps:

  1. Check Configuration

    • Verify all required fields filled
    • Test with demo data

  2. Review Logs

    • Module detail page → Error Log
    • Look for recent errors

  3. Permissions

    • Module may need additional Shopify scopes
    • Re-authorize if prompted

  4. Background Jobs

    • Settings → Module Jobs
    • Check if jobs are running

Get Help:

My loyalty module isn't awarding points correctly

The AI will diagnose and fix common issues.

Performance Issues

Module slowing down your store:

Check:

  1. Module Size

    • Some modules have heavy JavaScript
    • Check PageSpeed Insights

  2. Configuration

    • Reduce max items shown
    • Lazy load module content

  3. CDN

    • Verify widgets load from CDN
    • Check asset caching

Optimize:

Optimize the reviews module for better performance

Integration Conflicts

Multiple apps editing the same files:

Symptoms:

  • Module not displaying correctly
  • Theme looks broken
  • JavaScript errors

Solutions:

  1. Reinstall Module

    Reinstall the reviews module to fix theme conflicts

  2. Manual Integration

    • Switch to manual embed code
    • Place in unique location

  3. Contact Support

Advanced Configuration

Custom CSS

Add custom styling:

Module Config → Advanced → Custom CSS

/* Custom review styling */
#synton-reviews {
  border-radius: 10px;
  box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
}

#synton-reviews .star-rating {
  font-size: 24px;
}

JavaScript Hooks

For developers - add custom behavior:

// Listen for review submission
window.addEventListener('synton:review:submitted', function (event) {
  console.log('Review submitted:', event.detail);
  // Your custom code
});

Available hooks per module documented at: https://docs.synton.ai/api/modules/[module-name]

Webhook Configuration

Receive real-time notifications:

Module Config → Integrations → Webhooks

Events:

  • review.created
  • loyalty.points_awarded
  • cart.recovered
  • chatbot.escalated

Setup:

Webhook URL: https://yourdomain.com/synton-webhook
Secret: your-secret-key
Events: review.created, review.published

Payload Example:

{
  "event": "review.created",
  "shop": "yourstore.myshopify.com",
  "data": {
    "review_id": 12345,
    "product_id": 67890,
    "rating": 5,
    "title": "Amazing product!",
    "created_at": "2026-01-19T10:00:00Z"
  }
}

Next Steps

Now that you know how to deploy and configure modules:

Or deploy your first module:

I want to add [reviews/loyalty/chatbot/etc] to my store

The AI will guide you through the process!

Looking for something else? Browse all guides.