2 min read

Verify your VTEX integration before going live

Run through the following checklist before taking your Empathy Platform search experience live in your VTEX store, so you can confirm everything is correctly configured before shoppers start using search.

Work through the checklist sequentially. The Feed connector must be fully set up and synced before you can verify the Pixel app search experience.

note

This checklist assumes both the Feed connector and the Empathy Platform Pixel app are already installed and configured. If you haven't done that yet, start with Connect your VTEX catalog to Empathy Platform and Inject the Empathy search widget into your VTEX store first.

Feed connector

  • Verify the Feed connector app (empathymx.empathy-feed-connector) is installed in your VTEX account.
  • Confirm the feed has been sent correctly to Empathy Platform.
  • Confirm Empathy Platform has mapped the feed.

Pixel app

Script and initialization

  • Verify the Empathy script URL in pixel/head.html is set to the correct client environment.
  • Verify the Empathy script loads correctly by running console.log(window.InterfaceX) in your browser console.
  • Check that the initX configuration object in react/Components/EmpathySearchbar/index.tsx is updated with the correct values:
    • instance: the instance identifier assigned to your store in Empathy Platform.
    • lang: the language code that matches your store's locale.
    • currency: the currency code used in your store.
    • scope: desktop or mobile depending on your store's target device.

Optional features

  • If your store's products have variants, confirm the Variant callbacks are kept in initX.
  • If your store supports add-to-cart from search results, confirm the AddToCart callbacks are configured in initX.
  • If your store uses a quantity selector, verify the metadata.inputValue parameter is correctly set.
  • If your store uses wishlists, verify the vtex.wish-list dependency is listed in manifest.json. Otherwise, confirm it has been removed.

Functional testing

  • Test search and verify results appear correctly.
  • Test add-to-cart and remove-from-cart from search results, with and without variants.
  • Test wishlist-add and wishlist-remove from search results.
  • Confirm GA4 events appear in window.dataLayer after cart and wishlist interactions.

interact

For browser console checks to verify the widget, cart, wishlist, and GA4 event states, see Verify your integration in the Empathy Platform Pixel app guide.

warning

If something isn't working as expected after going through this checklist, see Troubleshoot the VTEX integration for a list of common issues and resolutions.