Klaviyo (v1) | Stitch Documentation

Klaviyo is supported by Stitch
This integration is powered by Singer's Klaviyo tap and certified by Stitch. Check out and contribute to the repo on GitHub.

For support, contact Stitch support.

Klaviyo feature snapshot

A high-level look at Stitch's Klaviyo (v1) integration, including release status, useful links, and the features supported in Stitch.

STITCH
Release status	Released on December 14, 2017	Supported by	Stitch
Stitch plan	Standard	API availability	Available
Singer GitHub repository	singer-io/tap-klaviyo
REPLICATION SETTINGS
Anchor Scheduling	Supported	Advanced Scheduling	Supported
Table-level reset	Unsupported	Configurable Replication Methods	Unsupported
DATA SELECTION
Table selection	Supported	Column selection	Supported
Select all	Supported
TRANSPARENCY
Extraction Logs	Supported	Loading Reports	Supported

Connecting Klaviyo

Step 1: Create a Klaviyo API key

Sign into your Klaviyo account.
Click the user menu (top right corner of the page), then click Account.
On the Account page, click Settings > API Keys.
On the API Keys page, click the Create API Key button to create an API key.
In the Label column, click the pencil icon next to the API key you just created.
Enter a label for the API key. For example: Stitch integration.
Click Save API Key.

Klaviyo API key

Keep this page open for now - you’ll need it to complete the setup in Stitch.

Step 2: Add Klaviyo as a Stitch data source

Sign into your Stitch account.
On the Stitch Dashboard page, click the Add Integration button.
Click the Klaviyo icon.
Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

For example, the name “Stitch Klaviyo” would create a schema called stitch_klaviyo in the destination. Note: Schema names cannot be changed after you save the integration.
In the API Key field, paste the Klaviyo API key you created in Step 1.

Step 3: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Klaviyo integration. This means that data equal to or newer than this date will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Klaviyo’s default setting of 1 year. For a detailed look at historical replication jobs, check out the Syncing Historical SaaS Data guide.

Step 4: Create a replication schedule

Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the Replication Scheduling documentation for more information.

In the Replication Frequency section, you’ll create the integration’s replication schedule. An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Klaviyo integrations support the following replication scheduling methods:

Replication Frequency
Anchor Scheduling
Advanced Scheduling using Cron (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the Understanding and Reducing Your Row Usage guide for tips on reducing your usage.

Step 5: Set objects to replicate

Is an object missing or not replicating? Verify that the object meets the requirements for selection and replication.

The last step is to select the tables and columns you want to replicate. Learn about the available tables for this integration.

Note: If a replication job is currently in progress, new selections won’t be used until the next job starts.

For Klaviyo integrations, you can select:

Individual tables and columns
All tables and columns

Click the tabs to view instructions for each selection method.

In the integration’s Tables to Replicate tab, locate a table you want to replicate.
To track a table, click the checkbox next to the table’s name. A blue checkmark means the table is set to replicate.
To track a column, click the checkbox next to the column’s name. A blue checkmark means the column is set to replicate.
Repeat this process for all the tables and columns you want to replicate.
When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.

Important: Using the Select All feature will overwrite any previous selections. However, selections aren’t final until Finalize Your Selections is clicked. Clicking Cancel will restore your previous selections. Refer to the Select All guide for more info about this feature.

Click into the integration from the Stitch Dashboard page.
Click the Tables to Replicate tab.
In the list of tables, click the box next to the Table Names column.
In the menu that displays, click Track all Tables and Fields:
Click the Finalize Your Selections button at the bottom of the page to save your data selections.

Initial and historical replication jobs

After you finish setting up Klaviyo, its Sync Status may show as Pending on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a Pending status indicates that Stitch is in the process of scheduling the initial replication job for the integration. This may take some time to complete.

Initial replication jobs with Anchor Scheduling

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the Anchor Scheduling documentation for more information.

Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Replication will continue after the seven days are over. If you’re no longer interested in this source, be sure to pause or delete the integration to prevent unwanted usage.

Klaviyo table reference

Schemas and versioning

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for version 1 of this integration.

This is the latest version of the Klaviyo integration.

Table and column names in your destination

Depending on your destination, table and column names may not appear as they are outlined below.

For example: Object names are lowercased in Redshift (CusTomERs > customers), while case is maintained in PostgreSQL destinations (CusTomERs > CusTomERs). Refer to the Loading Guide for your destination for more info.

bounce

The bounce table contains metrics related to Bounced Email events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	bounce schema on GitHub Klaviyo API method

bounce table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

campaigns

The campaigns table contains info about the campaigns in your Klaviyo account.

Replication Method

Full Table

Primary Key

Useful links

campaigns schema on GitHub

Klaviyo API method

campaigns table schema

campaign_type

STRING

created

DATE-TIME

from_email

STRING

from_name

STRING

is_segmented

BOOLEAN

list_id

STRING

message_type

STRING

name

STRING

num_recipients

INTEGER

object

STRING

send_time

DATE-TIME

sent_at

DATE-TIME

status

STRING

status_id

INTEGER

status_label

STRING

subject

STRING

template

OBJECT

Click to expand template

html

STRING

object

STRING

template_id

STRING

updated

DATE-TIME

click

The click table contains metrics related to Clicked Email events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	click schema on GitHub Klaviyo API method

click table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

clicked_sms

The clicked_sms table contains metrics related to Clicked SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	clicked_sms schema on GitHub Klaviyo API method

clicked_sms table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

consented_to_receive

The consented_to_receive table contains metrics related to Consented to Receive SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	consented_to_receive schema on GitHub Klaviyo API method

consented_to_receive table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

dropped_email

The dropped_email table contains metrics related to Clicked Email events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	dropped_email schema on GitHub Klaviyo API method

dropped_email table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

failed_to_deliver

The failed_to_deliver table contains metrics related to Failed to Deliver SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	failed_to_deliver schema on GitHub Klaviyo API method

failed_to_deliver table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

failed_to_deliver_automated_response

The failed_to_deliver_automated_response table contains metrics related to Failed to Deliver Automated Response SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	failed_to_deliver_automated_response schema on GitHub Klaviyo API method

failed_to_deliver_automated_response table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

global_exclusions

The global_exclusions table contains info about the global exclusions in your Klaviyo account.

Replication Method

Full Table

Primary Key

Useful links

global_exclusions schema on GitHub

Klaviyo API method

global_exclusions table schema

email

STRING

object

STRING

reason

STRING

timestamp

STRING

lists

The lists table contains info about the lists in your Klaviyo account.

Replication Method

Full Table

Primary Key

Useful links

lists schema on GitHub

Klaviyo API method

lists table schema

created

STRING

folder

STRING

list_type

STRING

name

STRING

object

STRING

person_count

INTEGER

updated

STRING

mark_as_spam

The mark_as_spam table contains metrics related to Marked Email as Spam events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	mark_as_spam schema on GitHub Klaviyo API method

mark_as_spam table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

open

The open table contains metrics related to Opened Email events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	open schema on GitHub Klaviyo API method

open table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

receive

The receive table contains metrics related to Received Email events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	receive schema on GitHub Klaviyo API method

receive table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

received_automated_response

The received_automated_response table contains metrics related to Received Automated Response SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	received_automated_response schema on GitHub Klaviyo API method

received_automated_response table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

received_sms

The received_sms table contains metrics related to Received SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	received_sms schema on GitHub Klaviyo API method

received_sms table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

sent_sms

The sent_sms table contains metrics related to Sent SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	sent_sms schema on GitHub Klaviyo API method

sent_sms table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

The subscribe_list table contains metrics related to Subscribed to List events.

Replication Method

Key-based Incremental

Replication Key

timestamp

Useful links

subscribe_list schema on GitHub

Klaviyo API method

unsub_list

The unsub_list table contains metrics related to Unsubscribed from List events.

Replication Method

Key-based Incremental

Replication Key

timestamp

Useful links

unsub_list schema on GitHub

Klaviyo API method

unsub_list table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

unsubscribe

The unsubscribe table contains metrics related to Unsubscribed events.

Replication Method

Key-based Incremental

Replication Key

timestamp

Useful links

unsubscribe schema on GitHub

Klaviyo API method

unsubscribe table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

unsubscribed_from_sms

The unsubscribed_from_sms table contains metrics related to Unsubscribed from SMS events.

Replication Method	Key-based Incremental
Primary Key	id
Replication Key	timestamp
Useful links	unsubscribed_from_sms schema on GitHub Klaviyo API method

unsubscribed_from_sms table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

update_email_preferences

The update_email_preferences table contains metrics related to Updated Email Preferences events.

Replication Method

Key-based Incremental

Replication Key

timestamp

Useful links

update_email_preferences schema on GitHub

Klaviyo API method

update_email_preferences table schema

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

Questions? Feedback?

Did this article help? If you have questions or feedback, feel free to submit a pull request with your suggestions, open an issue on GitHub, or reach out to us.

Related	Troubleshooting
Destination & Integration Compatibility Replication Scheduling Syncing Historical SaaS Data Resetting Replication Keys Nested Data Structures & Row Count Impact	Third-Party Downtime Understanding & Reducing Your Usage Re-Authorizing Integrations Replication Issues