The Klaviyo plugin for commercetools is a Node.js application that provides the ability to sync commercetools data into Klaviyo.
The plugin acquires data from commercetools in two different ways:
- Realtime data - events are received asynchronously via commercetools subscriptions, e.g. on order creation, customer creation, etc. On receipt of these events, relevant data is fetched (if necessary) from commercetools and synced in to Klaviyo.
- Bulk import - a set of API endpoints are provided to manually trigger the data sync into Klaviyo. Typical use cases include the synchronization of the product catalogue or of historical customers and orders. This is typically performed when installing the plugin for the first time but can also be done periodically if the data becomes out of sync.
Real-time data sync:
- Customer creation
- Customer update
- Order placed
- Order fulfilled
- Order cancelled
- Order refunded (single refund)
- Category created
- Category updated
- Category deleted
- Product deleted
Bulk data import:
- Orders
- Product Catalogue and categories
- Customers
Check data flow for all the details about the data exchanged between commercetools and Klaviyo.
See plugin installation documentation. Self hosted installation and commercetools Connect deployments are supported.
See how it works for the details on how the data is synced between commercetools and Klaviyo.
The process of setting up commercetools can differ based on the specific implementation, and the integration needs may
also vary in each scenario. Due to these variations, the plugin is distributed as an open source application to
facilitate the integration of these systems. This way, individuals are able to freely download, host, and customize the
solution according to their distinct business needs.
See plugin development and customization documentation for all the details
on how to customize the plugin and how to get it running locally.
We appreciate any and all contributions to this project! Before creating an issue or raising a PR, review our Contributing guide. This guide reviews issue creation, prerequisites for pull requests, and more.