Klaviyo Connector Setup Guide | Server-Side Connectors

API Information

This connector uses the following vendor API:

API Name: Klaviyo API
API Version: 2023-02-22
API Endpoint: https://a.klaviyo.com/api/
Documentation: Klaviyo API Reference

Connector Actions

Action Name	AudienceStream	EventStream
Update User Attributes	✓	✗
Add User to List (Real-Time)	✓	✗
Add User to List (Batched)	✓	✗
Remove User from List (Real-Time)	✓	✗
Remove User from List (Batched)	✓	✗

Configure Settings

Navigate to the Connector Marketplace and add a new connector. For general instructions on how to add a connector, see About Connectors.

After adding the connector, configure the following settings:

Private API Key
Required. Private API Key. See Obtain API credentials documentation for more information.

Create a list

If you do not already have a list at Klaviyo or you need to create a new one, use the following steps to create a list:

In the Connector Configuration window, click Create List. The Create List window will appear.
Under List Name, enter the list name.
Click Create and then click Done.

Actions

Enter a name for the action and select the action type from the drop-down menu.

The following section describes how to set up parameters and options for each action.

Update User Attributes

Parameters

Parameter	Description
Profile ID	The primary identifier that Klaviyo assigns to each user profile.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
Email	The email address associated with a user profile.
Phone Number	The phone number associated with a user profile.
Email	The individual’s email address.
Phone Number	The individual’s phone number in E.164 format.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. Format varies based on the external system.
Anonymous ID	For mobile app profiles, if Klaviyo cannot associate the user with an email address, an anonymous mobile app ID will represent the iOS profile.
First Name	Individual’s first name.
Last Name	Individual’s last name.
Organization	Name of the company or organization within the company for whom the individual works.
Title	Individual’s job title.
Image	URL pointing to the location of a profile image.
Address 1	First line of street address.
Address 2	Second line of street address.
City	City name.
Country	Country name.
Latitude	Latitude coordinate. We recommended a precision of four decimal places.
Longitude	Longitude coordinate. We recommended that you provide
Region	Region within a country, such as state or province.
Zip	Zip code.
Timezone	Time zone name. We recommended time zones from the IANA Time Zone Database.
Custom Properties	Map any custom properties assigned to this profile. Date attributes will be converted to ISO 8601 format. For example: `2021-09-15 13:34:08+00:00`.

Add User to List (Real-Time)

Parameters

Parameter	Description
List	Select the list to add the user to.
Profile ID	The primary identifier that Klaviyo assigns to each user profile.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. The format varies based on the external system.
Email	The email address associated with a user profile.
Phone Number	The phone number associated with a user profile.

Add User to List (Batched)

Batch Limits

This action uses batched requests to support high-volume data transfers to the vendor. For more information, see Batched Actions. Requests are queued until one of the following thresholds is met or the profile is published:

Max number of requests: 1000
Max time since oldest request: 10 minutes
Max size of requests: 1 MB

Parameters

Parameter	Description
List	Select the list to add the user to.
Profile ID	The primary identifier that Klaviyo assigns to each user profile.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. The format varies based on the external system.
Email	The email address associated with a user profile.
Phone Number	The phone number associated with a user profile.

Remove User from List (Real-Time)

Parameters

Parameter	Description
List	Select the list to remove user from.
Profile ID	The primary identifier that Klaviyo assigns to each user profile.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. The format varies based on the external system.
Email	The email address associated with a user profile.
Phone Number	The phone number associated with a user profile.

Remove User from List (Batched)

Batch Limits

Max number of requests: 1000
Max time since oldest request: 10 minutes
Max size of requests: 1 MB

Parameters

Parameter	Description
List	Select the list to remove user from.
Profile ID	The primary identifier that Klaviyo assigns to each user profile.
External ID	A unique identifier used by customers to associate Klaviyo user profiles with user profiles in an external system, such as a point-of-sale system. The format varies based on the external system.
Email	The email address associated with a user profile.
Phone Number	The phone number associated with a user profile.