Skip to main content

JavaScript SDK

Enable the JavaScript SDK to use Smile.js in custom JavaScript.

Updated this week

This article outlines when the JavaScript SDK is required and when it isn’t.

When you need the JavaScript SDK


You need to enable the JavaScript SDK if you want to:

  • Open the Smile Panel using JavaScript.

  • Use methods, objects, or event listeners from Smile.js.

  • Reward points for custom actions using JavaScript. (✅ Custom actions are available on Plus and Enterprise plans only.)

On Shopify and BigCommerce, enabling the JavaScript SDK automatically loads Smile.js and the full Smile UI on your storefront.

When you don’t need the JavaScript SDK


If you’re not using custom JavaScript, you don’t need to enable the JavaScript SDK.

Even when the JavaScript SDK is disabled, you can still:

Using Smile.js outside your storefront


Using Smile.js on a different website or storefront (outside of your primary Shopify or BigCommerce store) is an advanced use case.

In addition to enabling the JavaScript SDK, this requires API Access.(✅ API Access available on Plus and Enterprise plans only.)

How to enable or disable JavaScript SDK


To update this setting:

  1. From Smile Admin, go to Settings > Developer Tools.

  2. In the JavaScript SDK section:

    • Click Enable if you need Smile.js for custom JavaScript.

    • Click Disable if you don’t.

If you’re not using JavaScript-based customization, keeping this disabled can help reduce load times.

Did this answer your question?