> ## Documentation Index
> Fetch the complete documentation index at: https://chatbotx.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Klaviyo Integration
> Connect Klaviyo with ChatbotX to create or update a profile and add it to a selected list from a Flow.
The **Klaviyo** integration creates or updates a Profile from ChatbotX contact data directly within a Flow. The action uses the email address to identify the Profile, can add it to a List, and can sync Title, Organization, and Custom Properties.
For example, after a customer provides an email address for product advice, ChatbotX sends their contact details and interests to Klaviyo for Profile segmentation and content personalization.
## Prepare your Private API Key
Create a Klaviyo **Private API Key** before connecting the integration. Do not use the **Public API Key / site ID**, because it does not grant permission to create or update Profiles.
Sign in to the Klaviyo account that you want to connect to ChatbotX.
Open **Settings**, select the **General** tab, then select **API keys** from the left menu.
In **Private API Keys**, select **Create Private API Key** and enter a name that identifies the key.
Grant read and write access to **Profiles** and **Lists**. You can use **Full Access**, but you should grant only the permissions ChatbotX needs.
Finish creating the key, copy its value, and store it securely. Klaviyo does not display the complete Private API Key again after you close the creation window.
See the official [Obtain API credentials](https://developers.klaviyo.com/en/docs/retrieve_api_credentials) guide.
A Private API Key can read or change data according to its assigned permissions. Do not share it in emails, messages, public screenshots, or customer-facing documents.
## Connect Klaviyo to ChatbotX
In your ChatbotX workspace, select **Settings** from the left menu.
Select the **Integrations** tab, then open **Klaviyo**.
Select **Connect** to open the **Connect Klaviyo** window.
Paste the Private API Key into the **API Key** field, then select **Confirm**.
After the key is verified and has the required permissions, ChatbotX saves the connection and loads Klaviyo Lists for use in Flows.
## Add Klaviyo to a Flow
Place the Klaviyo action after collecting the email address and other data that you want to sync. The email address must be valid so Klaviyo can create or identify the Profile.
Select **Flows**, then open the Flow that you want to use to collect contacts.
In the Send Message node, select **+ Create**, then select **Actions**.
Open **Email Actions** and select **Add Contact to Klaviyo**.
Select **Edit** on the action to choose a List and sync Profile data.
## Configure Add Contact to Klaviyo
Configure the fields in the **Add Contact to Klaviyo** window, then select **Save**.
| Field | Configuration |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Klaviyo List** | Select the List that receives the Profile. If you leave this field empty, the action still creates or updates the Profile without adding it to a List. This field is optional. |
| **Email Field** | Select the ChatbotX field that stores the customer's email address. Klaviyo uses the email address to create a new Profile or identify an existing Profile. |
| **Title Field** | Select the field that stores the customer's job title or role. This field is optional. |
| **Organization Field** | Select the field that stores the customer's company or organization. This field is optional. |
| **Custom Fields in Klaviyo** | Select a contact field on the left and enter the Klaviyo property key on the right. Select **Add mapping** to add another sync row. |
The action provides two outcomes that you can connect to the next nodes in the Flow:
* **Success**: Klaviyo processed the request to create or update the Profile and add it to a List if you selected one.
* **Error**: The request failed because the email address, API Key, permissions, List, or synced data is invalid.
Connect each outcome to a different node to send a confirmation or handle the error.
**Add Contact to Klaviyo** does not subscribe the Profile to email marketing or change its consent status. Add a Profile to a List only after the customer agrees to receive the relevant content.
## Sync Custom Properties
Custom Properties store data specific to each Profile for segmentation, Template personalization, or Flow conditions in Klaviyo.
Each sync row has two parts:
* Left: the ChatbotX contact field that contains the data to send.
* Right: the property key that Klaviyo uses to store the data on the Profile.
Use short, recognizable, and consistent property keys. If you change the spelling of a property key, Klaviyo might save the value to a new property instead of updating the existing one.
## Example: Collect customers who need product advice
A fashion retailer wants to save customers who are interested in its products and segment them by their needs.
Use Get User Data to ask for the customer's email address, job title, company, and product interest.
Run **Add Contact to Klaviyo**, then select the **Email** field and a relevant List if the customer has agreed to receive messages.
Select the **Title Field** and **Organization Field**, then sync the product interest to a Custom Property.
Connect **Success** to a confirmation message. Connect **Error** to a branch that asks the customer to check their information or transfers the conversation to a team member.
## Test the integration
Before you Publish the Flow, test it with an email address that you can access.
* Open **Audience > Profiles** in Klaviyo and confirm that the Profile appears.
* Confirm that the email address, Title, Organization, and Custom Properties contain the correct data.
* If you selected a List, confirm that the Profile appears in the correct List.
* Confirm that the Flow follows the **Success** branch for a valid email address.
* Enter an invalid email address to test the **Error** branch.
* If Lists do not appear, review the Private API Key's Profiles and Lists permissions and reconnect the integration.
Deleting or revoking the Private API Key stops the current connection from working. Create a new key and update the connection in ChatbotX before running the Flow again.