Giter Club home page Giter Club logo

commercetools-klaviyo's Introduction

klaviyo-ct-plugin

The Klaviyo plugin for commercetools is a Node.js application that provides the ability to sync commercetools data into Klaviyo.

Overview

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.

Klaviyo CT Plugin architecture

Supported features

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.

Plugin installation

See plugin installation documentation. Self hosted installation and commercetools Connect deployments are supported.

How it works

See how it works for the details on how the data is synced between commercetools and Klaviyo.

Plugin development and customization

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.

Contributing

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.

commercetools-klaviyo's People

Contributors

andreshernandez-e2x avatar chaithra-shivaprasad avatar garethjohn-e2x avatar renovate[bot] avatar robertolosanno-e2x avatar viswajitkuna-e2x avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.