Klaviyo

Availability: Airbyte Cloud: ✅, Airbyte OSS: ✅
Support Level: Certified
Latest Version: 2.0.1
Definition Id: 95e8cffd-b8c4-4039-968e-d32fb4a69bde

This page contains the setup guide and reference information for the Klaviyo source connector.

Prerequisites

• Klaviyo account
• Klaviyo Private API key

Setup guide

Step 1: Set up Klaviyo

1. Create a Klaviyo account
2. Create a Private API key. Make sure you selected all scopes corresponding to the streams you would like to replicate. You can find which scope is required for a specific stream by navigating to the relevant API documentation for the streams Airbyte supports.

Step 2: Set up the Klaviyo connector in Airbyte

1. Log into your Airbyte Cloud account.
2. Click Sources and then click + new source.
3. On the Set up the source page, select Klaviyo from the Source type dropdown.
4. Enter a name for the Klaviyo connector.
5. For Api Key, enter the Klaviyo Private API key.
6. For Start Date, enter the date in YYYY-MM-DD format. The data added on and after this date will be replicated. This field is optional - if not provided, all data will be replicated.
7. Click Set up source.

Supported sync modes

The Klaviyo source connector supports the following sync modes:

• Full Refresh - Overwrite
• Full Refresh - Append
• Incremental - Append
• Incremental - Append + Deduped

Supported Streams

• Campaigns
• Email Templates
• Events
• Flows
• GlobalExclusions
• Lists
• Metrics
• Profiles

Performance considerations

The connector is restricted by Klaviyo requests limitation.

The Klaviyo connector should not run into Klaviyo API limitations under normal usage. Create an issue if you encounter any rate limit issues that are not automatically retried successfully.

Data type map

Integration Type	Airbyte Type	Notes
string	string
number	number
array	array
object	object

Changelog

Version	Date	Pull Request	Subject
2.0.1	2023-11-08	32291	Add logic to have regular checkpointing schedule
2.0.0	2023-11-03	32128	Use the latest API for streams campaigns, email_templates, events, flows, global_exclusions, lists, and metrics
1.1.0	2023-10-23	31710	Make start_date config field optional
1.0.0	2023-10-18	31565	added new known fields for 'events' stream
0.5.0	2023-10-19	31611	Add date-time format for datetime field in Events stream
0.4.0	2023-10-18	31562	Add archived field to Flows stream
0.3.3	2023-10-13	31379	Skip streams that the connector no longer has access to
0.3.2	2023-06-20	27498	Do not store state in the future
0.3.1	2023-06-08	27162	Anonymize check connection error message
0.3.0	2023-02-18	23236	Add Email Templates stream
0.2.0	2023-03-13	22942	Add Profiles stream
0.1.13	2023-02-13	22942	Specified date formatting in specification
0.1.12	2023-01-30	22071	Fix Events stream schema
0.1.11	2023-01-27	22012	Set AvailabilityStrategy for streams explicitly to None
0.1.10	2022-09-29	17422	Update CDK dependency
0.1.9	2022-09-28	17304	Migrate to per-stream state.
0.1.6	2022-07-20	14872	Increase test coverage
0.1.5	2022-07-12	14617	Set max_retries = 10 for lists stream.
0.1.4	2022-04-15	11723	Enhance klaviyo source for flows stream and update to events stream.
0.1.3	2021-12-09	8592	Improve performance, make Global Exclusions stream incremental and enable Metrics stream.
0.1.2	2021-10-19	6952	Update schema validation in SAT