Skip to main content
Open in Hubv The official Klaviyo integration allows your bot to interact with your Klaviyo account. You can use it to:
  • Create or update user profiles
  • Retrieve individual or bulk user profile data
  • Subscribe users to SMS/email marketing

​
Setup

You will need:
1

Install the integration in Botpress

First, install the integration to your bot:
  1. In Botpress Studio, select Explore Hub in the upper-right corner.
  2. Search for the Klaviyo integration, then select Install Integration.
In the Configuration menu, you should see one field: API Key. Leave it empty for now—you’ll come back to it after creating your Klaviyo API key.
2

Create a Klaviyo private API key

Next, create a private Klaviyo API key:
  1. Log in to your Klaviyo account.
  2. Select your organization’s name in the bottom-left corner.
  3. Select Settings. Then, navigate to API keys.
  4. Under Private API Keys, select Create Private API Key.
  5. Enter a name for the API key.
  6. Check Full Access for the following API scopes:
    • Profiles
    • Subscriptions
  7. Select Create in the upper-right corner.
  8. Copy the API key—it should start with pk.
3

Configure the integration in Botpress

Now, you can finish setting up the integration in Botpress:
  1. In the integration’s API Key field, paste your Klaviyo API key.
  2. Select Save Configuration.
Your Klaviyo integration is ready. You can use the integration’s Cards to interact with your Klaviyo account.

​
Cards

If you use any of the following Cards in an Autonomous Node, keep in mind that your bot will fill in the Card’s fields based on the user’s responses. This can lead to unexpected behaviour for fields that have strict conventions.For example, the Update Profile Card lets you update custom properties associated with a profile. If the user isn’t specific about that property’s exact name, the bot may accidentally create a new property instead of updating an existing one.
Here’s a reference for all Cards available with the integration:

​
Create Profile

​
Get Profile

​
Get Profiles

​
input
object

​
Subscribe Profiles

​
Update Profile