Klaviyo Integration

Lantern provides a rich integration with Klaviyo that pushes properties to customer profiles and triggers Metrics when events happen within Lantern.

Getting Started

1. Generate a private API key in Klaviyo following their instructions:

   • Give it a name like "Lantern" to remember what you generated it for
   • Select Full Access under Access Level
   • Make note of the generated key

2. Go to the Lantern Admin in Shopify and navigate to Settings → Integrations in the left side nav

3. Enter the API Key you generated into the field under the Klaviyo heading and save

4. Click the Send test events to Klaviyo button to verify the integration

5. Check the Metrics Activity Feed in Klaviyo to see examples of each Metric Lantern triggers

Customer Profile Properties

Lantern syncs the following properties to customer profiles in Klaviyo:

General

• LanternBirthDate: The customer's birth date

Loyalty

• LanternEnrolledAt: When the customer was enrolled in the loyalty program
• LanternPotentialLoyaltyPoints: The potential points a customer can earn if they signup for an account
• LanternLoyaltyPoints: The customer's current loyalty points balance
• LanternLoyaltyTier: The customer's current loyalty tier
• LanternLoyaltyCurrentTierSpendThreshold: Spend threshold for current tier
• LanternLoyaltyCurrentTierSpendRemaining: Spend required to maintain current tier
• LanternLoyaltyCurrentTierSpendPercentage: Percentage progress to maintain current tier
• LanternLoyaltySpend: Current period spend amount
• LanternLoyaltyNextTierName: Handle of the next available tier
• LanternLoyaltyNextTierSpendThreshold: Spend threshold for next available tier
• LanternLoyaltyNextTierSpendPercentage: Percentage progress towards next tier (0-100)
• LanternLoyaltyNextTierSpendRemaining: Spend remaining to reach next tier
• LanternLoyaltyTierResetDate: Date that the tier will be recalculated
• LanternLoyaltyPointExpirationDate: Date that the user's points will expire

Wishlists

• LanternWishlistItems: A list of all product variant IDs in the customer's wishlist

Lantern also syncs any customer properties you collect using earn event forms.

Available Metrics

General

Lantern Account Created

Triggered when a customer signs up for an account.

Lantern Account Activate

Triggered when a customer account invite is sent from Shopify.

Parameters:

• activationLink: The unique link to activate the account

Loyalty

Lantern Tier Change

Triggered when a customer moves to a new loyalty tier.

Parameters:

• tier: The new tier the customer is now in

Lantern Points Awarded

Triggered whenever a customer earns loyalty points.

Parameters:

• points: The number of points awarded

Referrals

Lantern Referral Invite

Triggered when an advocate uses the email invite to send a referral.

Parameters:

• advocateFirstName: First name of the advocate
• advocateLastName: Last name of the advocate
• message: The message the advocate wants to include with the invite
• referralLink: The advocate's unique referral link

Lantern Referral Awarded

Triggered on an advocate's profile when their friend is successfully referred.

Parameters:

• code: The unique code for the discount or gift card that was awarded

Lantern Referred

Triggered on a friend's profile when they successfully complete a referral.

Parameters:

• code: The unique code for the discount or gift card that was awarded

Wishlists

Lantern Back In Stock

Triggered when a product variant that a customer has added to their wishlist becomes back in stock.

Parameters:

• productVariantId: The ID of the product variant that is now back in stock

Lantern On Sale

Triggered when a product variant that a customer has added to their wishlist goes on sale.

Parameters:

• productVariantId: The ID of the product variant that went on sale