For the complete documentation index, see llms.txt. This page is also available as Markdown.

Klaviyo

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_ )

  • Do Not Send Phone Number: Prevents the Phone number metric from being sent to Klaviyo.

  • Do Not Fire Event Metrics: Disables Klaviyo event/metric functionality.

  • Do Not Send Placed Order Event: Prevents the Placed Order metric from being sent to Klaviyo.

  • Do Not Send Ordered Product Event: Prevents the Ordered Product metric from being sent to Klaviyo.

  • Do Not Send Fulfilled Order Event: Prevents the Fulfilled Order metric from being sent to Klaviyo.

  • Do Not Send Cancelled Order Event: Prevents the Cancelled Order metric from being sent to Klaviyo.

  • Do Not Send Refunded Order Event: Prevents the Refunded Order metric from being sent to Klaviyo.

  • Wait And Send Placed Order Event Via Task: 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 from the Thank You Page.

  • Send Placed Order Event For Successful Rebills: Check this to send Placed Order and Ordered Product metrics when triggering the Rebill Success routing type. By default, those metrics are only sent for Initial Sales. This setting will not have any effect if no Rebill Success routing exists. Enable this for conversion tracking / attributed revenue for recovery email flows.

  • 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.

  • Use Subscribe Profiles API: Send customers to Klaviyo’s Subscribe Profiles API to subscribe for marketing. You can use this to take advantage of double opt-in functionality in Klaviyo. If the list is configured for single opt-in in Klaviyo, then profiles will be subscribed directly without a confirmation message.

  • Use Email Address as the Customer Profile ID: 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 customer's coupon code to Klaviyo.

  • sendPaymentGatewayInfo: Enable this to send the Payment method and the Gateway name for the first order item as the Gateway and Payment customer profile properties.

  • WhatsApp Consent Collection: Enable WhatsApp consent collection for customers with a phone number and SMS or Marketing opt in consent. Do Not Send Phone Number must be disabled for consent to be sent to Klaviyo.

  • Only Send Events For Route Campaigns: Only send Klaviyo events/metrics for campaigns with routes configured. Leave the campaignId field blank.

After you click Connect, click on the enabled plugin again and then click on the Blue Edit icon

On the right side of the page you will need to route your Konnektive 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 Konnektive Campaign(s) to the Klaviyo List then select Create.


Campaign Settings

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.

You can leave the campaignId field blank and enable the Only Send Events For Route Campaigns plugin option to only send Klaviyo events/metrics for campaigns with routes configured.

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


Form-code

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.


Server Side Metrics

The Klaviyo Plugin is integrated to various Server Side Metrics at Klaviyo. The events are as follows

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.

Subscription Restarted

Sends data to Klaviyo when the purchase restarts billing. Event Properties: - Product Name - Purchase ID - Subscription Status: Active - Next Bill Date

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.

Do Not Send Phone Number: Prevents the Phone number metric from being sent to Klaviyo

Do Not Fire Event Metrics: Disables Klaviyo event/metric functionality. If the Use Email Address as the Customer Profile ID option is disabled, enabling this option will prevent a Klaviyo customer profile from being automatically created using the Import Click sessionId value.

Do Not Send Placed Order Event: Prevents the Placed Order metric from being sent to Klaviyo

Do Not Send Ordered Product Event: Prevents the Ordered Product metric from being sent to Klaviyo

Do Not Send Fulfilled Order Event: Prevents the Fulfilled Order metric from being sent to Klaviyo

Do Not Send Cancelled Order Event: Prevents the Cancelled Order metric from being sent to Klaviyo

Do Not Send Refunded Order Event: Prevents the Refunded Order metric from being sent to Klaviyo


Properties Sent to Klaviyo

  • email

  • phone_number

  • first_name

  • last_name

  • location

    • address1

    • address2

    • city

    • region

    • country

    • zip

  • BillingAddress

    • FirstName

    • LastName

    • Address1

    • Address2

    • City

    • RegionCode

    • CountryCode

    • Zip

    • Phone

  • ShippingAddress

    • FirstName

    • LastName

    • Address1

    • Address2

    • City

    • RegionCode

    • CountryCode

    • Zip

    • Phone

  • email_consent (adding to list / subscribing only)

  • Campaigns (campaign name - category name)

  • OrderId

  • OrderDate

  • OrderType

  • OrderStatus

  • ItemNames

  • items / OrderItems

    • value

    • ProductID

    • SKU

    • ProductName

    • Quantity

    • ItemPrice

    • RowTotal

    • ItemType

    • ItemBasePrice

    • ItemShippingPrice

    • ItemSalesTax

    • ItemDescriptor

    • PurchaseID (recurring products only)

    • PurchaseStatus (recurring products only)

    • BillingDate (recurring products only)

  • totalAmount

  • salesUrl

    • includeSalesUrl option must be enabled on plugin

  • CustomFields

    • sendCustomFields option must be enabled on plugin

  • Coupons

    • sendCoupons option must be enabled on plugin


Additional Notes:

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 Use Subscribe Profiles API 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.

Last updated