# Install this plugin
    yarn add @pinelab/vendure-plugin-klaviyo
    
    

Vendure Klaviyo Plugin

An extensible plugin for sending placed orders to the Klaviyo marketing platform.

Getting started

The default setup will only send placed orders to Klaviyo

  1. Log in to your Klaviyo account and get your API key
  2. Add the following config to your vendure-config.ts:
import { KlaviyoPlugin } from '@pinelab/vendure-plugin-klaviyo';

plugins: [
        plugins: [
            KlaviyoPlugin.init({
                apiKey: 'some_private_api_key'
            })
        ],
];

All placed orders will now be synced

Custom event handlers

If you want to send more events to Klaviyo, you can implement your own handlers. For example, syncing account verification events to Klaviyo, so that you can send out welcome e-mails:

  1. Create a custom handler klaviyo-account-verified-handler.ts

    import { AccountVerifiedEvent } from '@vendure/core';
    import { KlaviyoEventHandler } from '@pinelab/vendure-plugin-klaviyo';
    
    /**
     * Event handler to send Vendure's AccountVerifiedEvent to Klaviyo
     */
    export const accountVerifiedHandler: KlaviyoEventHandler<AccountVerifiedEvent> =
      {
        vendureEvent: AccountVerifiedEvent,
        mapToKlaviyoEvent: async (event, injector) => {
          const { customer } = event;
          return {
            // Unique ID per event to make the event idempotent
            uniqueId: `account-verified-${customer.id}-${Date.now()}`,
            eventName: 'Account Verified',
            profile: {
              emailAddress: customer.emailAddress,
              externalId: customer.id.toString(),
              firstName: customer.firstName,
              lastName: customer.lastName,
            },
            eventProperties: {
              myCustomProperty: 'my custom value',
            },
          };
        },
      };
    
  2. Register the handler in the plugin in your vendure-config.ts

    import {
      defaultOrderPlacedEventHandler,
      KlaviyoPlugin,
    } from '@pinelab/vendure-plugin-klaviyo';
    import { accountVerifiedHandler } from './klaviyo-account-verified-handler.ts';
    
    plugins: [
      KlaviyoPlugin.init({
        apiKey: 'some_private_api_key',
        eventHandlers: [defaultOrderPlacedEventHandler, accountVerifiedHandler],
      }),
    ];