Upgrade Guide

Steps to migrate to Tweakwise JS + Plugin Studio

Consider this as a new integration. Remove everything you have.

Here’s a step-by-step plan to migrate safely:

  • Audit and remove old Tweakwise JS code
  • Enable Plugin Studio
  • Implement in the recommended order

1. Audit & remove existing Tweakwise JS

  • Inventory current integration.
    • Identify all Tweakwise-related scripts, initialization code.
    • Note any custom local configuration overrides (for example, passing custom filterTemplateId, sortingTemplateId, or other options). These may need to be re-applied or ported later.
    • Event Tag events (search, clicks, pageviews, add-to-cart, other events) can be left as-is.
  • Remove / comment out old JS.
    • Remove classic JS import scripts (for Search, Suggestions, Commerce, Recommendations, etc.).
    • Clean up any custom initialization code, but document what you’re removing. Keep a backup or version control branch.
  • Deploy a “clean slate” in a staging environment.
    • Before proceeding, make sure your staging or test environment no longer loads the old Tweakwise JS components.
    • This ensures that when you start fresh with Plugin Studio, there are no conflicts or duplicated behavior.

2. Enable Plugin Studio

Contact Tweakwise Support / Onboarding Specialist, if Plugin Studio is not already activated for your account. Tweakwise

Ensure you have a Tweakwise test (sandbox) environment for Plugin Studio configuration changes. You’ll want to preview tile designs and module behavior before going live.

3. Implement in the recommended order

According to Tweakwise’s recommended integration path: Tweakwise JS - Getting started