This integration is powered by Singer's Klaviyo tap. For support, visit the GitHub repo or join the Singer Slack.
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 plan |
Standard |
API availability |
Available |
| Singer GitHub repository | |||
| REPLICATION SETTINGS | |||
| Anchor Scheduling |
Supported |
Advanced Scheduling |
Supported |
| Table-level reset |
Unsupported |
Configurable Replication Methods |
Unsupported |
| DATA SELECTION | |||
| Table selection |
Supported |
Column selection |
Unsupported |
| 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.
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_klaviyoin 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:
- For tables using Key-based Incremental Replication, data equal to or newer than this date will be replicated to your destination.
- For tables using Full Table Replication, all data - including records that are older, equal to, or newer than this date - will be replicated to your destination.
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
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:
-
Advanced Scheduling using Cron (Enterprise 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
The last step is to select the tables 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 **
-
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.
- Repeat this process for all the tables you want to replicate.
- When finished, click the Finalize Your Selections button at the bottom of the screen to save your selections.
- 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.
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
| Replication Method : |
Key-based Incremental |
Replication Key  :
|
|
Primary Key  :
|
id |
API endpoint : |
|
id
The bounce ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
The click ID. Reference: |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
dropped_email
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
This is the dropped ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
global_exclusions
| Replication Method : |
Full Table |
Primary Key :
|
|
| API endpoint : | |||
The global_exclusions table contains info about the global exclusions in your Klaviyo account.
|
email
This is the of the globally excluded emails. |
|
object
|
|
reason
|
|
timestamp
|
| Replication Method : |
Full Table |
Primary Key :
|
None |
| API endpoint : | |||
The lists table contains info about the lists and segments in your Klaviyo account.
|
created
|
|
id
|
|
name
|
|
object
|
|
person_count
|
|
type
|
|
updated
|
mark_as_spam
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
The spam ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
This is the open ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
receive
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
This is the receive ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
subscribe_list
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
The subscribe ID. |
||
|
datetime
|
||
|
event_name
|
||
|
event_properties
|
||
|
object
|
||
|
person
|
||
|
statistic_id
|
||
|
timestamp
|
||
|
uuid
|
unsub_list
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
This is the unsubscribe list ID. |
||
|
datetime
|
||
|
event_name
|
||
|
event_properties
|
||
|
object
|
||
|
person
|
||
|
statistic_id
|
||
|
timestamp
|
||
|
uuid
|
unsubscribe
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
None |
API endpoint : |
|
id
The unsubscribe ID. |
|
datetime
|
|
event_name
|
|
event_properties
|
|
object
|
|
person
|
|
statistic_id
|
|
timestamp
|
|
uuid
|
update_email_preferences
| Replication Method : |
Key-based Incremental |
Replication Key :
|
|
|
Primary Key :
|
id |
API endpoint : |
|
id
This is the update email ID. |
||
|
datetime
|
||
|
event_name
|
||
|
event_properties
|
||
|
object
|
||
|
person
|
||
|
statistic_id
|
||
|
timestamp
|
||
|
uuid
|
| Related | Troubleshooting |
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.