Klaviyo is a powerful ecommerce platform that lets you boost your business revenue. It offers unique features like category-based segmentation and various event triggers based on page views, purchases, email engagement, etc.
Find the open source transformer code for this destination in the GitHub repository.
Setup
In your RudderStack dashboard, go to Directory > Destinations > Cloud Destinations and search for Klaviyo.
Connect your source and click Continue.
Connection settings
Configure the following settings to set up Klaviyo as a destination in RudderStack:
Name: Assign a name to uniquely identify the destination.
Public API Key: Enter the unique public API key from your Klaviyo dashboard (present under Settings > Account).
Private API Key: Enter the private API key from your Klaviyo dashboard (present under Settings > Account). This key lets you add users to a list or subscribe them using personalised emails/SMS.
Connection mode
Specify how you want to route events from your source to Klaviyo.
RudderStack supports sending events to Klaviyo via the following connection modes:
Connection mode
Web
Mobile
Server
Device mode
Supported
-
-
Cloud mode
Supported
Supported
Supported
In a web device mode integration, that is, using JavaScript SDK as a source, RudderStack loads the Klaviyo native SDK from https://static.klaviyo.com/ domain. Based on your website’s content security policy, you might need to allowlist this domain to load the Klaviyo SDK successfully.
Configuration settings
After completing the initial setup, configure the following settings to correctly receive your data in Klaviyo:
List and subscription settings
List Id: Enter the default list ID to which you want to add or subscribe the identified users.
Consent: Select the consent type from E-mail, SMS, or both. consent is a Klaviyo-specific property that you need to include in your events if you run a GDPR-compliant business.
Event-specific settings
Enable this option to make email as primary identifier: Turn on this setting to set a custom attribute _id and $email as the primary identifier when passed in traits.email/properties.email. RudderStack does not set $id field to the userId while sending the events.
When disabled, RudderStack uses userId (anonymousId, if userId is absent) for mapping the user with a unique identifier. In case userId and anonymousId are absent, RudderStack sends email or phone as the user’s primary identifier.
Note that:
This setting is applicable for identify and track calls.
Use this setting only if you are experiencing issues with duplicate profiles created in your Klaviyo account.
Enable to flatten user/event properties: Turn on this setting to flatten the user properties in identify and event properties in track calls before sending them to Klaviyo.
Web SDK settings
Use the following settings to configure Klaviyo’s native web SDK:
Send Page As Track: Turn on this setting to send page events as track events along with the event name and category.
Additional Page info: Turn on this setting to send page events as track events and send additional properties for the event.
Other settings
Client-side Events Filtering: This setting lets you specify which events should be blocked or allowed to flow through to Klaviyo. See Client-side Events Filtering guide for more information.
OneTrust Cookie Categories: This setting lets you associate the OneTrust cookie consent groups to Klaviyo.
Identify
The identify call lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.
You can send any number of key-value pairs as user traits and RudderStack updates them as custom profile properties in Klaviyo.
To create a new user in Klaviyo, you must pass either the userId, email, or phone properties in the identify call. If a user already exists, RudderStack updates the user profile with the latest values.
Note that specifying consent and smsConsent in the event properties overrides the respective settings in the RudderStack dashboard.
Add and subscribe user to list
This feature is available only in the cloud mode integration.
You can add and subscribe a user to a Klaviyo list by specifying the List ID in the RudderStack dashboard and setting the subscribe option to true. Alternatively, you can add listId within the event properties - this will override the List ID specified in the dashboard for that particular event.
If you have enabled the Double opt-in setting for a list in Klaviyo, users will not be added to the list automatically without their consent. To add users to a list automatically without waiting for their consent, select the Single opt-in option in that list’s settings:
Track
The track call lets you record the user actions along with any properties associated with them.
In the above snippet, RudderStack captures the information related to the Checked Out event, along with the details of the event.
To associate a user with an event, you need to pass either their userId, email, or phone in the track call. A sample server-side track call along with the user information is as shown:
In the above snippet, RudderStack captures the information related to the Item Purchased event, along with its additional information in properties. Moreover, since this event is captured using a server-side SDK, RudderStack passes the user information in context along with a unique userId.
To send track or screen type event using an SDK that does not persist user context information after identify, you need to pass the information in context.traits.
To set a specific value to the screen or track type event, you need to pass the event-related property in the properties field. Also, you can send revenue property in the track event and RudderStack will automatically map it to Klaviyo’s special property $value.
Ecommerce event mapping
RudderStack converts the following ecommerce events to the corresponding Klaviyo events:
RudderStack event
Klaviyo event
Product Viewed Product Clicked
Viewed Product
Product Added
Added to Cart
Checkout Started
Started Checkout
In addition to the above, RudderStack sends the following:
Customer properties: Must contain either the email or phone_number. RudderStack extracts these customer properties from traits/context.traits in the track call.
As mentioned above, you can send any number of key-value pairs as user traits and RudderStack updates them as custom profile properties in Klaviyo.
Token: Public API key from the RudderStack dashboard.
Additionally, you can choose to send specific fields for each of the events covered in the following sections:
Product Viewed
RudderStack maps the Product Viewed event to Viewed Product and maps the following event properties:
RudderStack property
Klaviyo property
name
ProductName
product_id
ProductID
sku
SKU
image_url
ImageURL
url
URL
brand
Brand
price
Price
compare_at_price
CompareAtPrice
categories
Categories
Product Added
RudderStack maps the Product Added event to Added to Cart and maps the following event properties:
RudderStack property
Klaviyo property
value
$value
name
AddedItemProductName
product_id
AddedItemProductID
sku
AddedItemSKU
image_url
AddedItemImageURL
url
AddedItemURL
price
AddedItemPrice
quantity
AddedItemQuantity
categories
AddedItemCategories
item_names
ItemNames
checkout_url
CheckoutURL
items (deprecating soon) products
Items
properties.items will be deprecated soon.
Furthermore, products/items can contain the following parameters:
RudderStack parameters
Klaviyo parameters
product_id
ProductID
sku
SKU
name
ProductName
quantity
Quantity
price
Price
total
RowTotal
url
URL
image_url
ImageURL
categories
ProductCategories
Checkout Started
RudderStack maps the Checkout Started event name to Started Checkout and maps the following event properties:
RudderStack Parameters
Klaviyo Parameters
order_id
$event_id
value
$value
categories
Categories
item_names
ItemNames
items (deprecating soon) products
Items
checkout_url
CheckoutURL
properties.items will be deprecated soon.
Furthermore, products / items can contain the following parameters:
RudderStack parameters
Klaviyo parameters
product_id
ProductID
sku
SKU
name
ProductName
quantity
Quantity
price
Price
total
RowTotal
url
URL
image_url
ImageURL
categories
ProductCategories
A sample track call containing the above ecommerce event parameters is shown below:
When sending events via web device mode, specifying order_id is not mandatory, as Klaviyo automatically assigns the timestamp to the event. However, if explicitly specified, it must be unique. Klaviyo automatically discards the events containing a duplicate order_id.
Page
RudderStack supports sending page events to Klaviyo only via device mode.
The page call lets you record your website’s page views with any additional relevant information about the viewed page.
You can send the name and category information in the page event by enabling the Send Page As Track setting in the RudderStack dashboard. To associate the properties with the page view event, enable the Additional Page info setting as well.
This site uses cookies to improve your experience while you navigate through the website. Out of
these
cookies, the cookies that are categorized as necessary are stored on your browser as they are as
essential
for the working of basic functionalities of the website. We also use third-party cookies that
help
us
analyze and understand how you use this website. These cookies will be stored in your browser
only
with
your
consent. You also have the option to opt-out of these cookies. But opting out of some of these
cookies
may
have an effect on your browsing experience.
Necessary
Always Enabled
Necessary cookies are absolutely essential for the website to function properly. This
category only includes cookies that ensures basic functionalities and security
features of the website. These cookies do not store any personal information.
This site uses cookies to improve your experience. If you want to
learn more about cookies and why we use them, visit our cookie
policy. We'll assume you're ok with this, but you can opt-out if you wish Cookie Settings.