Klaviyo is a marketing automation platform used by consumer brands to manage email, SMS, and other messaging channels from a single account. It unifies customer and behavioral data so businesses can build personalized, cross-channel marketing campaigns and automated flows.
Hevo uses the Klaviyo REST API to replicate data from your Klaviyo account to the Destination of your choice. To ingest data, you must provide Hevo with a Private API Key generated from your Klaviyo account that grants read access to your account’s data.
Supported Features
| Feature Name | Supported |
|---|---|
| Capture deletes | No |
| History mode | No |
| Custom data (user-configured tables & fields) | No |
| Data blocking (skip objects and fields) | Yes |
| Resync (objects and Pipelines) | Yes |
| API configurable | No |
Prerequisites
-
An active Klaviyo account exists from which data is to be ingested.
-
The Private API Key is available to provide Hevo access to your Klaviyo account data.
Obtain the API Key
You require a Private API Key to authenticate Hevo with your Klaviyo account. The API key does not expire and can be reused across all your Pipelines.
Note: To create the API key, you must have the Owner, Admin, or Manager role on your Klaviyo account.
Perform the following steps to obtain the API key:
-
Log in to your Klaviyo account.
-
In the left navigation pane, click the Profile icon, and then click Settings.
-
On the Settings page, under the General tab, click API keys.
-
In the Private API Keys section, click Create Private API Key.
-
On the Create Private API Key page, do the following:
-
In the Private API Key Name field, specify a name for the API key. For example, Klaviyo Connector for Hevo.
-
In the Select Access Level section, specify one of the following:
-
Read-Only Key: This level provides read-only access across all API scopes.
-
Custom Key: This level provides read-only access to the specified API scopes. If you select this option, you must provide Read Access for the following API scopes:
-
Profiles
-
Metrics
-
Events
-
-
-
Click Create.
-
-
On the Private API Key Confirmation page, click the copy icon to copy the key, and save it securely like any other password.
Use this key while configuring your Pipeline. If the Private API Key configured in the Pipeline is revoked manually from your Klaviyo account, Hevo cannot authenticate with the Source. As a result, all active jobs for the Pipeline fail, and no data is replicated. To resume data replication, modify the Source configuration in the Pipeline with a valid Private API Key. Once the updated key is saved, Hevo re-authenticates the Source, and data ingestion resumes from the last saved offset.
Configure Klaviyo as a Source in your Pipeline
Perform the following steps to configure your Klaviyo Source:
-
Click Pipelines in the Navigation Bar.
-
Click + Create Pipeline in the Pipelines List View.
-
On the Select Source Type page, select Klaviyo.
-
On the Select Destination Type page, select the type of Destination you want to use.
-
In the Configure Source screen, specify the following:
-
Source Name: A unique name for your Source, not exceeding 255 characters. For example, Klaviyo Source.
-
In the Connect to your Klaviyo account section, specify the following:
-
Private API Key: The Private API Key that you obtained from your Klaviyo account.
-
Historical Sync Duration: The duration for which you want to ingest existing data from the Source. This cannot be changed after the Pipeline is created. Default: 3 Months.
-
-
-
Click Test & Continue to test the connection to your Klaviyo Source. Once the test is successful, you can proceed to set up your Destination.
Data Replication
Hevo replicates data for all the objects selected on the Configure Objects page during Pipeline creation. By default, all supported objects and their available fields are selected. However, you can modify this selection while creating or editing the Pipeline.
Hevo ingests the following types of data from your Source objects:
-
Historical Data: The first run of the Pipeline ingests all available historical data for the selected objects, for the duration specified in the Historical Sync Duration field, and loads it into the Destination.
-
Incremental Data: Once the historical load is complete, new and updated records for objects are ingested as per the sync frequency.
For the event object, Hevo ingests only the incremental data in subsequent Pipeline runs. Incremental changes are detected using the timestamp field.
Klaviyo enforces a rate limit of 350 requests per second and 3,500 requests per minute on the Events API. If this limit is exceeded, a rate limit exception occurs. To understand how Hevo handles such scenarios, read Handling Rate Limit Exceptions.
Note: You can create a Pipeline with this Source only using the Merge load mode. The Append mode is not supported for this Source.
Schema and Primary Keys
Hevo uses the following schema to upload the records to the Destination. For a detailed view of the objects, fields, and relationships, click the ERD.
Data Model
The following is the list of tables (objects) that are created at the Destination when you run the Pipeline:
| Object | Description |
|---|---|
| event | Contains details of the actions taken by profiles in your Klaviyo account, such as email opens, clicks, and purchases. Each event references the associated metric and profile, and, where applicable, the campaign or flow that triggered it. |