Klaviyo
Last updated
Last updated
Go to Admin → Plugins → Email Service Providers, click Klaviyo, and select the green Activate button.
FriendlyName: Used to easily identify the Klaviyo plugin
API_KEY: Enter the private API_KEY and phoneCode provided by Klaviyo to enable the Plugin.
(API_KEY should start with pk_ )
OmitPhone: Prevents the Phone number metric from being sent to Klaviyo
excludeSession: Prevents sessionId value from being sent to Klaviyo
excludePlacedOrderSession: Prevents the Placed Order metric from being sent to Klaviyo
excludeOrderedProductSession: Prevents the Ordered Product metric from being sent to Klaviyo
excludeFulfilledOrderSession: Prevents the Fulfilled Order metric from being sent to Klaviyo
excludeCancelledOrderSession Prevents the Cancelled Order metric from being sent to Klaviyo
excludeRefundedOrderSession: Prevents the Refunded Order metric from being sent to Klaviyo
sendPlacedOrderSessionViaTask: Check this to send Placed Order and Ordered Product metrics when contacts are exported to Klaviyo Lists instead of it being sent when calling import click on Thank You Page.
campaignId - If entered, the above server-side metrics will only be sent for orders tied to this specific campaignId. If left blank, server-side metrics will fire as normal.
isSMS: send customers to Klaviyo’s subscribe list to take advantage of double opt-in functionality in Klaviyo
useEmailLead: use email address as the primary ID in Klaviyo. If unchecked the order session ID is used.
includeSalesUrl: Enable this to use Klaviyo’s abandoned cart feature
sendCustomFields: Send all the customer custom fields to Klaviyo, if the customer has any
sendCoupon: Send the customers coupon code to Klaviyo.
After you click Connect, click on the enabled plugin again and then click on the Blue Edit icon
On the right side of the plugin configuration page you will need to route your CheckoutChamp Campaign(s) to the Klaviyo List you created inside your Klaviyo account.
Click on the Green Route + icon and use the drop down options to route your CheckoutChamp Campaign(s) to the Klaviyo List then select Create.
While the campaign routes determine what combination of CRM events / campaigns / products should trigger adding customers to specific Klaviyo lists, the campaignId field determines which campaigns send server-side metrics to this Klaviyo account.
| campaignId | excludeSession | Event Tracking | Email Lists |
|---|---|---|---|
Blank | Disabled | Event tracking (ex Placed Order) will be sent for all campaigns | Customers will be added to lists as setup in campaign routing |
Blank | Enabled | No event tracking | Customers will be added to lists as setup in campaign routing |
3 | Disabled | Event tracking (ex Placed Order) will be sent for campaign 3 only | Customers will be added to lists as setup in campaign routing |
3 | Enabled | No event tracking | Customers will be added to lists as setup in campaign routing |
The CheckoutChamp funnels will send a Started Checkout event to Klaviyo when a checkout page is loaded with products in the shopping cart. If there are not yet products in the cart (such as consumer must make product selection on the checkout page), then event is not sent to Klaviyo.
To send the Started Checkout event, the Klaviyo plugin campaign must be blank or must match the funnel campaign and excludeSession=unchecked
The form-code downloaded from within the Landing Page section of your campaign will contain Klaviyo’s StartedCheckout script which sends data for partial orders to Klaviyo
Will need to redownload the form-code package and deploy the new config file if Klaviyo is added after form-code is already deployed onto the site.
The script added within form-code can run in tandem with the Campaign Routing ability explained in the first part of this article but omit the “Partial” Customer Type routings.
The Klaviyo Plugin is integrated to various Server Side Metrics at Klaviyo. The events are as follows
Started Checkout | Sends data to Klaviyo at the time the customer lands on a checkout page |
Placed Order | Sends data to Klaviyo at the time an order is placed |
Ordered Product | Sends data to Klaviyo at the time an order is placed, item specific data. Typically paired with Placed Order metric. |
Cancelled Order | Sends data to Klaviyo when an order is cancelled in the CRM. |
Refunded Order | Sends data to Klaviyo when an order is refunded in the CRM. |
Fulfilled Order | Sends data to Klaviyo when the fulfillment record tied to an order is marked Shipped in the CRM. |
This data sends independently from the Klaviyo Plugin Routing. By default the plugin will send data to Klaviyo whenever the above events occur in the CRM. There are now several options in the Klaviyo Plugin Advanced Settings where you can choose whether to send data or not based on the events above.
If you wish to not send data for a particular server side metric, please check the appropriate box to exclude that from being sent.
OmitPhone: Prevents the Phone number metric from being sent to Klaviyo
excludeSession: Prevents sessionId value from being sent to Klaviyo
excludePlacedOrderSession: Prevents the Placed Order metric from being sent to Klaviyo
excludeOrderedProductSession: Prevents the Ordered Product metric from being sent to Klaviyo
excludeFulfilledOrderSession: Prevents the Fulfilled Order metric from being sent to Klaviyo
excludeCancelledOrderSession Prevents the Cancelled Order metric from being sent to Klaviyo
excludeRefundedOrderSession: Prevents the Refunded Order metric from being sent to Klaviyo
sendPlacedOrderSessionViaTask: Check this to send Placed Order and Ordered Product metrics when contacts are exported to Klaviyo Lists instead of it being sent when calling import click on Thank You Page.
campaignId - If entered, the above server-side metrics will only be sent for orders tied to this specific campaignId. If left blank, server-side metrics will fire as normal.
isSMS: send customers to Klaviyo’s subscribe list to take advantage of double opt-in functionality in Klaviyo
useEmailLead: use email address as the primary ID in Klaviyo. If unchecked the order session ID is used.
When exporting the phone number to Klaviyo, the CRM will automatically insert the country code based on the country captured inside of the billing address.
The isSMS option only sends a contact to Klaviyo’s subscribe list. To opt-in a consumer to SMS messages, use the contactOptIn option when importing the order or lead.
