import { InProductAction, getOsShortcut } from "docs-ui"

export const metadata = { title: Klaviyo Integration, }

{metadata.title}

Add Klaviyo to build email lists and send marketing campaigns to your customers.

Klaviyo lets you send automated emails for abandoned carts, order confirmations, and marketing campaigns. Bloom sets it up for you in minutes.

When to Integrate Klaviyo

Integrate Klaviyo if you want to:

• Build email lists and grow your marketing audience.
• Sync your products with Klaviyo for dynamic email content.
• Send campaigns and automated emails from Klaviyo.

Prerequisites

Before adding Klaviyo, you need a Klaviyo account and API keys.

Klaviyo Private API Key

Your Klaviyo Private API Key allows Bloom to send data from your store to Klaviyo. To get your Private API Key:

1. Log in to your Klaviyo account.
2. Click your profile icon in the bottom left, then choose "Settings."
3. Click "API Keys" in the left sidebar.
4. Click "Create Private API Key."
5. Give your key a name (like "Bloom Store") and give full access to List and Profiles.
6. Copy your Private API Key.

Klaviyo List ID

Your Klaviyo List ID is where Bloom will add subscribers from your store. To get your List ID:

1. In your Klaviyo dashboard, go to "Audience" > "Lists & Segments."
2. Click on the list you want to use (or create a new one).
3. In the URL, find the List ID (a string of letters and numbers after /list/). For example, if the URL is https://www.klaviyo.com/lists/abc123, your List ID is abc123.
4. Copy your List ID.

---

Add Klaviyo to Your Store

To add Klaviyo using the <InProductAction product={"bloom"} type={"MEDUSA_AI_OPEN_PANE"} data={{ pane: "integrations" }}>Integrations</InProductAction> panel:

1. Press <Kbd>{getOsShortcut()}</Kbd> + <Kbd>k</Kbd> to open the preview tab switcher.
2. Select the "Integrations" tab from the list.
3. Find the Klaviyo card in the available integrations.
4. Click "Build" on the Klaviyo card.

Bloom will start setting up Klaviyo and ask you questions about which features you want to enable.

---

Answer Bloom's Questions

After you click "Build," Bloom asks questions to configure Klaviyo:

1. Where should the newsletter form appear? Choose from options like footer, popup, or homepage section. Bloom may skip this question if your store already has a newsletter form.
2. Do you want to generate a product feed? A product feed allows you to sync your products with Klaviyo for dynamic email content. Answer "yes" to enable this feature.

After you answer these questions, Bloom asks for your Klaviyo credentials:

1. Klaviyo Private API Key: Paste the Private API Key you copied from your Klaviyo dashboard.
2. Klaviyo List ID: Paste the List ID where you want to add subscribers.
3. Storefront URL: This will only be required if you enabled the product feed. It will be used for the URLs in your product feed. You should use the live URL of your store if you have it, or the preview URL if you don't.

After you provide this information, Bloom will complete the Klaviyo integration setup for you.

<Note title="Technical Information">

Bloom stores your Klaviyo credentials as environment variables in your store. They're never exposed in your code or logs. See Environment Variables for more details.

</Note>

---

Test Subscription with Klaviyo

After Bloom finishes the setup, test Klaviyo in your preview store:

1. Open your <InProductAction product={"bloom"} type={"MEDUSA_AI_OPEN_PANE"} data={{ pane: "store" }}>store</InProductAction> preview.
2. Subscribe using the newsletter form.
3. Check that the subscriber is added to your Klaviyo list.

---

Add Product Feed to Klaviyo

If you enabled the product feed, Bloom will share the URL to that feed (for example, https://your-store.com/product-feed?currency_code=usd&country_code=us) in the chat after setup.

The product feed will include your product information for a specific currency and country. You can use this feed in Klaviyo to create dynamic email content that shows your products.

To add the product feed to Klaviyo:

1. Copy the product feed URL that Bloom shared in the chat.
2. In your Klaviyo dashboard, go to "Content" > "Products"
3. Click the "Add Custom Products" button.
4. Click the "Add Source" button.
5. In the form, enter a name for the source (like "Bloom Product Feed") and paste the product feed URL. You don't need to add username and password for the source.
6. Click "Define Source" to add the product feed to Klaviyo.

You can now use the product feed in your Klaviyo email templates to show dynamic product content.

---

Publish Klaviyo Integration

Once you've tested Klaviyo and it's working correctly, publish your store to make it live with production credentials.

To publish your Klaviyo integration:

1. Click the "Publish" button at the top right of your project.
2. If you haven't published before, Bloom asks for details about your store.
3. Bloom will ask you to enter your live Klaviyo credentials (Private API Key and List ID). Enter the same credentials you used for the preview since Klaviyo doesn't differentiate between environments.
4. Click "Publish" to make your changes live.

Your Klaviyo integration is now active on your live store. You can track real customer events and send marketing campaigns.

Update Product Feed URL

After publishing, make sure to update the product feed URL in your Klaviyo source to use your live backend URL instead of the preview URL. This ensures that your product feed continues to work correctly after publishing.

The backend URL is your admin URL without the /app path. For example, if your admin URL is https://your-store.com/app, your backend URL is https://your-store.com. Update the product feed URL in Klaviyo to https://your-store.com/product-feed?currency_code=usd&country_code=us.

---

Need Help?

If you face any issues while adding Klaviyo to your Bloom store, contact support or submit feedback.