Docs

Klaviyo

Add a bot to Klaviyo using the official integration.

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

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.

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.

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.

Cards

Create Profile

Create a profile in Klaviyo: either email or phone is required

inputobject
outputobject

Get Profile

Get a profile in Klaviyo

inputobject
outputobject

Get Profiles

Get profiles using filters in Klaviyo

inputobject
outputobject

Subscribe Profiles

Subscribe profiles asynchronously to a SMS and/or email marketing in Klaviyo

inputobject
outputobject

Update Profile

Update a profile in Klaviyo

inputobject
outputobject

Triggers