Skip to main content
490 Topics
Help Center

Catalog lookup tag reference

You will learn Learn how to use the catalog tag, which allows you to reference specific product information from your catalog within your emails, SMS, and push messages. This is useful when you want to create custom product recommendations, or cross-reference product information. For example, if you're using your own recommendation engine, you can pass your own product recommendations as event or profile data to Klaviyo, and then utilize that data in templates. Please note that this guide is designed for tech-savvy marketers or customers who have access to a developer. The {% catalog %} tag The {% catalog %} tag uses the following syntax: {% catalog itemID unpublished="cancel" %} ... {% endcatalog %} Replace itemID with the Product ID of the product you are referencing. This is the Product ID as synced from your own product catalog. Note, this lookup is specifically for the Product ID and not the SKU. Including unpublished="cancel" will ensure that you don't send your message in the event that the item referenced is unpublished. This argument is optional.  If any item referenced in your message is unpublished in your catalog at the time of lookup, the entire message will be skipped. For a given flow message, you can navigate to Analytics > Recipient Activity > Other and see a list labeled Skipped: Catalog Item Unavailable. This list includes all profiles that were skipped because an item featured in the message was out-of-stock or otherwise unavailable. When using this feature, between the opening and closing catalog tags, you can reference specific data from the item associated with the itemID in your Klaviyo product catalog. The following data is available to reference inside of a {% catalog %} block. Template tag Name Description {{ catalog_item.description }} Description The description of the item. {{ catalog_item.url }} URL The url for accessing the item in your store. {{ catalog_item.title }} Title The title of the item. {% currency_format catalog_item.metadata|lookup:"price" %} Price The price of an item. This tag formats the item price with the correct currency prefix. {{ catalog_item.featured_image.full.src }} Full image The url for the full image of the item. Use this inside of an image block, or an <img> tag. {{ catalog_item.featured_image.thumbnail.src }} Thumbnail The url for the full image of the item. Use this in an <img> tag in custom HTML, or use it as a dynamic image placeholder URL surrounded by the opening and closing {% catalog %} tags  {{ catalog_item.id }}  Id The Product ID of the item. {{ catalog_id }} Catalog ID The ID of the catalog so you can specify which catalog to pull from if you have multiple.  There may be additional data fields available that are considered metadata. To reference one of these additional item properties, you can use the variable syntax: {{ catalog_item.metadata.color }}. In this case, the variable will pull in the "color" value associated with the item stored in the item's metadata. To access a preview of all available details stored on an item — including all metadata — add the following snippet to a text block in a test template, and update itemID with the Product ID of one of the current products in your catalog. {% catalog itemID %} {{ catalog_item }} {% endcatalog %} Then, preview the message. This preview provides a raw version of all the data available for your products. Additionally, if you have multiple catalogs (i.e., you are syncing multiple custom catalogs to your account) you can specific which catalog you want to pull from using the {{ catalog_id }} tag. For example:  {% catalog "womens-jewelry-bundle" integration="demandware" catalog_id="catalogID"%} {{ catalog_item.internal_id }} {% endcatalog %} Look up an item ID passed with an event Using a catalog lookup with an event is mostly used in the following scenarios: If you're using a custom integration where product recommendations are passed along with an event to show in the message. For example, a browse abandonment message where unique recommendations are generated based on viewed items. Instead of populating the single item a customer viewed in the message, you can generate and populate a set of recommended items based on that item viewed. A set of Product IDs needs to be sent to Klaviyo along with the event. If you're using a custom integration and you prefer not to send all product details that need to go in an message. For example, with an abandoned cart message, only send the Product IDs of all abandoned items and Klaviyo can look up each one to pull in all relevant details. There's no need for every event to contain product name, price, image, etc. since all of this can be populated by only passing the Product ID to Klaviyo, then looking up the information in your Klaviyo product catalog. When using a {% catalog %} tag with an event, the lookup is based on the Item ID of the catalog item (this will either be Product ID or SKU depending

Help Center

How to resync your Shopify catalog feed

You will learn Learn how to resync your Shopify catalog items and categories to Klaviyo to see the most up-to-date information. There are currently 4 functions available for catalog resync: resyncing an individual item, resyncing a page of items (up to 25 items at a time), refreshing the category names in your catalog, and resyncing item membership in a particular category. Currently, manual catalog resync functionality is only available to customers using Shopify.  Before you begin If you have not already, read our guide on Getting started with Shopify for step-by-step instructions on integrating, before continuing with this article. It is important to note the following: Klaviyo syncs items from Shopify in real time, so typically items will be updated without the need for a resync. New categories and item membership in a particular category are synced from Shopify every 6 hours, so a category resync is helpful to view the most up-to-date information in Klaviyo. Currently, there is no way to resync an entire catalog at once. How to resync an individual item To resync an individual item and its attributes (e.g., item name, item price, SKU): In Klaviyo, click the Content dropdown on the left, then select Products. On the products page, search for the item you wish to resync by name or item ID. Click on the item’s name to open the item page. From there, click Resync Item in the upper right. You’ll receive a green success callout indicating that your item has been updated. How to resync a page of items You can resync a page of items at a time, with up to 25 items on one page. This will resync all details of every item on the page. In Klaviyo, click the Content dropdown on the left, then select Products. Use the search function or filter by status or category to control what items show up on a single page. Note that if you happen to have multiple catalog sources, you will see the option to filter by catalog name, and you must filter by Shopify in order to access resync functionality.  To resync a page of items, click the resync button (circular arrows) in the upper right. A popup will ask if you would like to resync those items. Click Resync Items to continue. Once the items on the page have resynced, a green success callout will appear. How to refresh all category names In Klaviyo, click the Content dropdown on the left, then select Products. Select Categories. Here, you can refresh all the category names from your Shopify store by clicking Refresh all names. This action will bring in new category names or delete a category that no longer exists in Shopify, but it will not resync the individual items in a category or the membership of items in a category. This means that the new category will be empty until you sync it individually (see the following section) or until the next 6 hour periodic sync. A green success callout will appear once the categories have been updated.  How to resync an individual category To resync item membership in an individual category: In Klaviyo, click the Content dropdown on the left, then select Products. Flip over to Categories. Click the resync icon on the far right next to the category you wish to update. A green success callout will appear once the category has been updated. Note that this action does not resync the details of individual products in that category.  Outcome You have now resynced whatever items, pages, or categories you selected.  Additional resources How to sync a custom catalog feed to Klaviyo (Developer resource)  How to use product feeds and recommendations 

Help Center

Getting started with Shopware

You will learn Learn how to integrate with Shopware 6 in order to bring site activity, order, catalog, and subscriber data into Klaviyo. Before you begin Before integrating, make sure: You’ve logged in to the Klaviyo account you wish to integrate. Shopware 6 is not listed on the integrations tab in Klaviyo. Typically, integrations not listed in the tab are third-party integrations not supported by Klaviyo. The Shopware 6 integration is an exception: it is supported by Klaviyo through our partner Overdose Digital. If you need to contact support, see the section below on how to do so. Download and install the extension You can install via of one of two methods: via Composer, or via downloading our extension from Github and then uploading to Shopware.  Install via Composer When installing via Composer, you'll need to specify the Klaviyo extension version; not all extensions work for all Shopware versions.  Are you using a Shopware version between 6.4.4.0 and 6.4.20.2? Run the command with the following extension version: composer require klaviyo/shopware-klaviyo:1.14.2 Are you using a Shopware version between 6.5.0.0 and 6.5.8.10? Run the command with the following extension version: composer require klaviyo/shopware-klaviyo:2.16.2 Are you using a Shopware version 6.6.0.0 or above? Run the command with the following extension version: composer require klaviyo/shopware-klaviyo:3.3.2 Install via upload Find Klaviyo's free extension at these links and click the Download button: Using a Shopware version between 6.4.4.0 and 6.4.20.2? Download Klaviyo extension version 1.14.2. Using a Shopware version between 6.5.0.0 and 6.5.8.10? Download Klaviyo extension version 2.16.2. Using Shopware version 6.6.0.0 or above? Download Klaviyo extension version 3.2.2. Log in to your Shopware admin for the store you wish to integrate. Click Extensions > My extensions. Click Upload extension. Select the Klaviyo extension from your files. Once the extension appears on your extension list, click Install. Toggle on the Klaviyo extension. Configure the extension in Shopware In your Shopware store admin, navigate to Settings and click the Extensions tab. Select Klaviyo. You will be brought to the Klaviyo extension settings page. Under Sales Channels, select the sales channel you wish to integrate with Klaviyo from the dropdown. Only integrate one sales channel with Klaviyo per Shopware store. You must also configure your settings for each sales channel individually. Under Interaction settings, select the cookie consent tool you’d like to use with this integration. Note that visitors who do not accept Klaviyo cookies will not be tracked by Klaviyo, nor will they be able to view Klaviyo forms. The cookie consent tool options are: NothingIf this option is selected, Klaviyo has free access to store cookies. Shopware DefaultIf this option is selected, cookie management will be implemented via Shopware's default method, given that it's turned on. To turn it on, navigate to Settings > Shop > Basic information, find the Security and Privacy section, and then toggle on Use Default Cookie Notification. CookieBotIf this option is selected, cookie management will be implemented by CookieBot. If you wish to select CookieBot, you must already have it installed on your Shopware store. Consent Manager If this option is selected, consent management will be implemented via Consent Manager. If you wish to select Consent Manager, you must already have it installed on your Shopware store. Usercentrics CMPIf this option is selected, consent management will be implemented via Usercentrics CMP. If you wish to select Usercentrics CMP, you must already have it installed on your Shopware store. If you do not use a cookie management tool (which already blocks Klaviyo’s script from loading) and want to speed up page load times, toggle on the setting Initialize Klaviyo After First Interaction With Page. This will enable the following behavior: After the client starts interacting with the page, the Klaviyo scripts will be initialized. On subsequent page transitions, the scripts will be initialized immediately. To continue, obtain your public and private API keys from Klaviyo. To do this, open a new tab and log in to the Klaviyo account you want to integrate with Shopware.  Click your account name in the lower left and select Settings. Select API keys. Click Create Private API Key. Give the key a name, then select Full Access Key and click Create. On the next page, click Copy Key. Paste the private API key into the corresponding setting within Shopware. Back in Klaviyo, click Done. Then, copy your public API key from the page. Paste the public API key in Shopware in the corresponding box. Next, pick a Klaviyo list from the dropdown for profiles who subscribe via a Shopware form to be added to. Select an identifier to use for Back in Stock variant field mapping. You should use the identifier that matches the one you use in your cata

Help Center

How to enable webhooks for Magento 2

You will learn Learn how to enable Klaviyo webhooks, which will empower your Magento 2 integration to sync catalog product removals real-time, and enable consent at checkout.  Before you begin If you have not already enabled your Magento 2 integration, you will need to complete the setup steps outlined in the Magento 2 Integration guide, which also includes instructions on enabling Klaviyo webhooks.  Enable webhooks Log in to your Magento 2 account and navigate to Stores > Configuration from the admin dashboard. Click on Klaviyo and select the Webhooks tab. Create a webhook secret and enter it into the corresponding Webhook Secret field. The webhook secret is a key that Klaviyo will use for validation. This secret can be anything you choose, but we recommend creating a secure string of letters and numbers. Magento will hide your webhook secret with asterisks for security purposes, so be careful to enter it correctly.If you are using a multi-store integration, the webhook secret in this field should be entered in your default configuration, and the same secret will be used as validation for each store configuration. The webhook secret should only be added to the default config and should not be added per store. Next to Use Product Delete Webhook? select Yes from the dropdown options. The Product Delete webhook allows the integration to remove products that you have deleted in Magento 2 from the catalog in Klaviyo.  Click Save Config to complete the setup. Your Magento 2 integration will now remove deleted products from the catalog in real-time. Additional resources How to Integrate with Magento 2.x (CE and EE) Reviewing Your Magento 2 Data

Help Center

Getting started with Wix

You will learn Learn how to easily integrate Klaviyo with your Wix site in order to sync customer profile, order, and catalog information to Klaviyo. With this data, you’ll be able to reach customers with targeted messaging through segmentation, automated flows, and campaigns.  Integrating with Wix will: Create a historic sync of all data (customer, order, catalog) to your Klaviyo account. Create a real-time sync of data to your Klaviyo account going forward. Enable the use of Klaviyo sign-up forms and Active on Site visitor tracking through the automatic addition of Klaviyo’s onsite JavaScript to your site. With Klaviyo sign-up forms, you can collect both email and SMS subscribers. Please note that Klaviyo embedded forms do not work for Wix. Enable the addition of Wix email subscribers (collected through a Wix footer form or at checkout) to a Klaviyo list (also known as an audience). Before you begin In order to use Klaviyo’s integration with Wix, your Wix site must: Have a premium plan Have a connected domain Be published When you integrate Wix with Klaviyo, you should only connect one Wix store per Klaviyo account. If you try to add a second Wix store, it will replace the first, but there will still be data from the first store in your account. If you have multiple Wix stores, you should connect them to separate Klaviyo accounts.  Integration video Check out our step-by-step video on integrating with Wix. How to integrate with Wix In your Klaviyo account, click on your company or organization name in the bottom left hand corner, then click Integrations. Select Add integrations, search for Wix, and click the card. Then, click Install. Click Connect to Wix. You’ll be brought to your Wix account and prompted to login (if you are not currently logged in). Once you’ve logged in, review the permissions and click Add to Site to be brought back into Klaviyo. Review your store URL setting to make sure that you’ve chosen the correct Wix account to integrate with Klaviyo. The setting Automatically add Klaviyo onsite JavaScript is checked by default; leave it checked if you would like to enable Klaviyo’s Active on Site tracking and signup forms. Check the setting Add Wix email subscribers to a Klaviyo list if you would like to do so; customers who opt-in to email via Wix, such as during checkout or with a Wix footer form, will be automatically added to the Klaviyo list you select. Select a Klaviyo list from the dropdown, such as your Newsletter list, that you wish to add subscribers to. If you need to create a new list in Klaviyo, navigate to the Lists & Segments tab in the Audience dropdown. Click Create List/Segment. Name the list and assign any tags. Click Create List. Click Complete Setup. After a loading screen, you should see a success message reading Your Wix account is now connected to Klaviyo! You’ve finished integrating and your Wix data will now start syncing to Klaviyo. If you ever need to edit your Wix settings: In your Klaviyo account, click on your company or organization name in the bottom left hand corner, then click Integrations. Select Wix on the list of Enabled Integrations. You’ll be brought to the integration settings page, where you can make changes. Click Save Settings. Data synced from Wix to Klaviyo To check on the data sync from Wix to Klaviyo: In your Klaviyo account, click on your company or organization name in the bottom left hand corner, then click Integrations. Select Wix on the list. Select the Data tab at the top. Here, you’ll see recent data synced from Wix to Klaviyo, and a sync progress bar for your historical data sync.  If you are experiencing issues with your sync, select Restart Import here to restart the historical data sync.  The data synced from Wix to Klaviyo includes: Known site visitors tracked as Active on Site events (if you left the onsite JavaScript setting checked) Email subscribers (if you chose to add them to a Klaviyo list) Profile information associated with order events Your Wix catalog The following order events: Abandoned Checkout (note that there is no historical sync of Abandoned Checkout events, only a sync going forward from the time you integrate) Placed Order Modified Placed Order Ordered Product Refunded Order Canceled Order Fulfilled Order  Fulfilled Partial Order For more information on the properties associated with each event synced from Wix, check out our article Wix data reference. Create automated messaging with Wix There are a number of pre-built flows for Wix in Klaviyo’s flow library, which you can use to personalize customer messaging.  These flows can be accessed by: Selecting the Flows tab in Klaviyo. Clicking Browse Ideas in the upper right. Selecting Wix from the filter dropdown next to the search bar. These pre-built flows include abandoned cart reminder, customer winback, cross sell, and repeat purchase nurture flows.  Troubleshooting Why aren't my Wix subscribers being added to my Klaviyo list