Klaviyo

Klaviyo is a marketing automation platform that automates eCommerce SMS and email marketing. It helps businesses acquire, retain and grow their customers by sending marketing emails.

See the Schema section for a list of objects available for replication.

A high-level look at this connector, including useful links, and supported features.

Feature/Capability	Support details
Supported Qlik Talend Data Integration projects	Replication projects only. Data pipeline projects are not supported.
Target update methods	Replication tasks: Apply changes Store changes Landing data in a data lake tasks: Change data capture (CDC)
Managing metadata	Manual metadata generation is not required.
Schema evolution	Only the Change column data type operation is supported.
Replication of LOB columns (NCLOB, CLOB, and BLOB)	Not supported.
Scheduled CDC	Required. This is how the target is kept up-to-date with changes to the source. For replication tasks, see Scheduling CDC for replication tasks For lake landing tasks, see Scheduling CDC for lake landing tasks
Notifications	Partially supported Setting notifications for changes in operation
Monitoring	CDC-only, as full load is not relevant for this connector. Monitoring an individual data task
Automatic denesting of JSON column payloads	Not supported. JSON column payloads in source datasets are not denested automatically on the target.

Preparing for authentication

To access your data, you need to authenticate the connection with your account credentials.

Make sure that the account you use has read access to the tables you want to fetch.

To generate the API key:

Log into your Klaviyo account.
Click your account name.
Go to Settings > API Keys.
Click Create API Key to create an API key.
In the Label column, click the pencil icon next to the API key you just created.
Enter a name for the API key. For example: Qlik.integration.
Click Create.
Copy the key.

Creating the connection

For more information, see Connecting to SaaS applications.

Fill in the required connection properties.
Provide a name for the connection in Connection name.
Select Open connection metadata to define metadata for the connection when it has been created.
Click Create.

Connection settings
Setting	Description
Data gateway	Select a Data Movement gateway if required by your use case. Information note This field is not available with the Qlik Talend Cloud Starter subscription, as it does not support Data Movement gateway. If you have another subscription tier and do not want to use Data Movement gateway, select None. For information on the benefits of Data Movement gateway and use cases that require it, see Qlik Data Gateway - Data Movement.
Start Date	Enter the date, in the format `MM/DD/YYYY`, from which the data must be replicated from your source to your target.
API Key	API key.

Schema

Schemas and naming conventions can change from version to version. It is recommended to verify your version before continuing.

The schema and info displayed below is for version 1.

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

bounce

The bounce table contains metrics related to Bounced Email events.

Replication Method	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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

Klaviyo API method

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

This is a nested data structure:

html: STRING
id: STRING
object: STRING

template_id

STRING

updated

DATE-TIME

click

The click table contains metrics related to Clicked Email events.

Replication Method	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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

Klaviyo API method

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

Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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

CDC

Replication Key

timestamp

Useful links

Klaviyo API method

unsub_list

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

Replication Method

CDC

Replication Key

timestamp

Useful links

Klaviyo API method

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

CDC

Replication Key

timestamp

Useful links

Klaviyo API method

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	CDC
Primary Key	id
Replication Key	timestamp
Useful links	Klaviyo API method

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

CDC

Replication Key

timestamp

Useful links

Klaviyo API method

datetime

STRING

event_name

STRING

event_properties

OBJECT

STRING

object

STRING

person

OBJECT

statistic_id

STRING

timestamp

INTEGER

uuid

STRING

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here