Klaviyo Destination

Klaviyo is a powerful email platform focused on ecommerce that helps companies make more money. It supports segmentation based on category and event triggers like product bought, page viewed, email engagement, or amount spent.

It measures opens, clicks, revenue generated, breakdown of generated revenue based on custom attributes (like type of campaign or amount gained per recipient), and provides trend reports, cohort analysis, and subscriber growth

Ultimately, Klaviyo lets you send personalized newsletters, automates triggered emails, product recommendations, welcome campaigns, order announcements, push notifications and sync your data to facebook custom audiences.

Are you trying to set up Klaviyo as an Event Source to get data into your warehouse or other downstream tools? Go here.

This document was last updated on September 6, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, let us know!

Getting Started

Before you start, make sure Klaviyo supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

1. From the Segment web app, click Catalog.
2. Search for “Klaviyo” in the Catalog, select it, and choose which of your sources to connect the destination to.
3. Navigate to your Account > Settings > API Keys in the Klaviyo’s UI and copy your “API Key” into the Segment Settings UI.
4. Note: Private API Key is required to use the List API. You can find this by going to Klaviyo’s UI and clicking Account > Settings > API Keys > Create API Key in order to generate a Private API Key and copy it into the Segment Settings UI.

Page

If you’re not familiar with the Segment Specs, take a look to understand what the Page method does. An example call would look like:

analytics.page();

NOTE: page calls are only supported client-side on analytics.js.

Identify

If you’re not familiar with the Segment Specs, take a look to understand what the Identify method does. An example call would look like:

analytics.identify({
  userId: 'user123',
  traits: {
    name: 'Serena Williams',
    gender: 'female'
  }
})

Client side Identify

When you call identify on analytics.js, we call Klaviyo’s identify with the traits object. We augment the traits object to have traits.$id be the userId since Klaviyo takes the user ID on the traits object itself.

Note: When sending data to Klaviyo using analytics.js, an initial page call is required. By default, this is already added in your Segment snippet.

We will map the following Segment spec’d traits to Klaviyo special people properties:

Server side Identify

When you call identify from one of our mobile or server-side libraries, we will create/update a Klaviyo person with the traits you provide in the identify.

If your userId is an email, or you provide an email in traits.email, we’ll send it as the $email property to Klaviyo. We will map the following Segment spec’d traits to Klaviyo special people properties:

Enforce Email as Primary Identifier

If this option is enabled, we will never set $id field to your userId when you call .identify() or .track(). Instead, we will only set a custom attribute id and only set $email as the primary identifier with your traits.email or properties.email. You should be careful when enabling this option and understand its full implications. This should only be enabled if you are experiencing an issue with duplicate profiles being created inside Klaviyo.

Fallback on Anonymous ID

Server side identify calls require a userId unless you enable sending anonymous data. Enable this option to fallback on anonymousId if userId is not available when sending server side events. Note that this option may result in superfluous user profiles in Klaviyo and is generally not recommended.

Adding users to a list

When you call identify using a server side library, you can optionally send list data in order to add that person to a specific List in Klaviyo. We will use their List API.

In order for this to work, you must add the Private Key inside the Klaviyo settings in Segment. You can generate a private key by clicking Account > Settings > API Keys > Create API Key inside Klaviyo.

You can choose to provide a default listId that we can fallback on when adding users to a list. If you’d like to override this default listId, you can also do so by sending it manually using code in destinations.Klaviyo.listId.

Important: You must provide an email in your traits or send email as the userId. Be sure to provide the Private Key in the Klaviyo settings for this to work.

node example:

analytics.identify({
  userId: '019mr8mf4r',
  traits: {
    name: 'Serena Williams',
    email: 'swilliams@sportstech.com',
    plan: 'Enterprise',
    friends: 42
  },
  integrations: {
    Klaviyo: {
      listId: 'baV129', // will override whatever it is in the UI setting
      confirmOptin: false // optional
    }
  }
});

Confirm Optin

You can also choose whether you want to force users to confirm the optin to your list. This flag determines whether someone is sent an email with a confirmation link before they are added to the list. The default settings will be true. However, you can uncheck this option in the Klaviyo settings inside Segment or override it per identify call using code in the integration.Klaviyo.confirmOptin parameter.

Note: This setting should only be set to false or unchecked if you have already received explicit permission from that person to add them to this list. Inappropriately setting Klaviyo.confirmOptin to false without explicit permission of the people added can result in your Klaviyo account being suspended and/or terminated by Klaviyo.

Track

If you’re not familiar with the Segment Specs, take a look to understand what the Track method does. An example call would look like:

analytics.track({
  userId: 'user123',
  event: 'Item Added',
  properties: {
    price: 39.95,
    type: 'Dress',
    colour: 'Red',
    shippingMethod: '2-day'
  }
})

Client side Track

When you call track on analytics.js, we call Klaviyo’s track with the same parameters.

Server side Track

When you call Track from one of our mobile or server-side libraries, we will key the user using the userId, but we will also provide the Klaviyo $email customer_property if your userId is an email, or you provide email as one of your event properties.

We will also map the following Segment spec’d properties to Klaviyo’s special people properties:

Ecommerce

The below table shows the out of the box mappings in our integration between our e-commerce spec and Klaviyo’s spec:

The below table shows the parameter mappings in our integration between Order Completed properties and and Klaviyo’s standard properties:

Order Completed

Klaviyo supports the Order Completed event that is outlined in our specs. If you send us a Order Completed event, we will send Klaviyo a Placed Order event and a Ordered Product event for each item listed in the properties.products array. We will also attach customer_properties with the userId set as $id for each of those Klaviyo events.

While it is not included in our spec for a Order Completed event, you can optionally include a productUrl and or imageUrl as a property of an item inside the products array. We will pass those along to Klaviyo as Product URL and Image URL respectively.

Each auto-generated Ordered Product event requires a unique $event_id, which Segment automatically generates based on a combination of the orderId of the parent Order Completed event, and the productId, id or sku of the product itself (in this order). In other words, you must pass either a productId, id or sku to Segment, or Klaviyo will reject your Ordered Product events.

An example Order Completed event may look like this using the node.js library:

analytics.track({
  userId: '019mr8mf4r',
  event: 'Order Completed',
  properties: {
    orderId: '50314b8e9bcf000000000000',
    total: 30,
    revenue: 25,
    shipping: 3,
    tax: 2,
    discount: 2.5,
    coupon: 'hasbros',
    currency: 'USD',
    repeat: true,
    products: [
      {
        id: '507f1f77bcf86cd799439011',
        sku: '45790-32',
        name: 'Monopoly: 3rd Edition',
        price: 19,
        quantity: 1,
        category: 'Games',
        productUrl: 'http://www.example.com/path/to/product',
        imageUrl: 'http://www.example.com/path/to/product/image.png',
      },
      {
        id: '505bd76785ebb509fc183733',
        sku: '46493-32',
        name: 'Uno Card Game',
        price: 3,
        quantity: 2,
        category: 'Games'
      }
    ]
  }
});

Send Placed Order Events as Order Completed

Enable this setting if you’d like to send Order Completed events as is rather than changing the event name to Placed Order on the server side (client side always sends Order Completed). It is recommended that you keep this setting enabled so that both client and server side Klaviyo integration sends the same event for Order Completed. Klaviyo does not treat the event names differently in their backend feature wise. This option was introduced to bridge the existing disparity between our client and server side integration regarding how this event name is sent without forcibly breaking the current behavior.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

API Key

Your API key

Confirm Optin

This flag determines whether someone is sent an email with a confirmation link before they are added to the list. Defaults to true (checked). This should only be set to false or unchecked if you have already received explicit permission from that person to add them to this list.

Enforce Email as Primary Identifier

If this option is enabled, we will never set $id field to your userId when you call .identify() or .track(). Instead, we will only set a custom attribute id and only set $email as the primary identifier with your traits.email or properties.email. You should be careful when enabling this option and understand its full implications. This should only be enabled if you are experiencing an issue with duplicate profiles being created inside Klaviyo.

Enter your Private Key

Note: this is required to use the List API. You can find this by going to Klaviyo’s UI and clicking Account > Settings > API Keys > Create API Key

Fallback on Anonymous ID

Enable this option to fallback on anonymousId if userId is not available when sending server side events. Note that this option may result in superfluous user profiles in Klaviyo and is generally not recommend. If this option is unchecked, we will only accept server side events that includes the userId.

List ID

Insert the ID of the default list that you’d like to subscribe users to when you call .identify().

Send Placed Order Events as Order Completed

Enable this setting if you’d like to send Order Completed events as is rather than changing the event name to Placed Order on the server side (client side always sends Order Completed). It is recommended that you keep this setting enabled so that both client and server side Klaviyo integration sends the same event for Order Completed. Klaviyo does not treat the event names differently in their backend feature wise. This option was introduced to bridge the existing disparity between our client and server side integration regarding how this event name is sent without forcibly breaking the current behavior.