Send data to Klaviyo¶
Klaviyo is an email platform for targeting, personalizing, measuring, and optimizing email and Facebook campaigns.
Use Amperity to manage audience lists in Klaviyo. Build a query using the email field, with optional additional customer profile fields, and then send the results of that query to Klaviyo. The audience list will be updated to match the query.
Note
This destination uses the Klaviyo REST API .
Amperity uses the Update Profile endpoint in the Klaviyo API to send customer profile attributes to Klaviyo.
Review the rate limits that are applied to endpoints in the Klaviyo REST API to manage customer profiles.
Before sending a set of customer profiles to Klaviyo, and to help set expectations, you should review the rate limits and estimate the amount of time required to complete the process of adding your set of customer profiles to Klaviyo.
This topic describes the steps that are required to send audience lists to Klaviyo from Amperity:
Get details¶
Klaviyo requires the following configuration details:
A private API key. |
|
The list name to which the Klaviyo connector will write. This can be the name of an existing list or a new list. Note Klaviyo supports up to 1000 lists and/or segments in your account at any given time. |
|
A query that outputs the fields that must be mapped to the Klaviyo audience. |
How do I find Klaviyo account, private API key, and audience information?
You can find all of this information after you log into Klaviyo.
A private API key is associated with your account username. Click your username, then Account, then Settings, and then API Keys. Create a new private API Key for use with Amperity, and then copy it.
There can be many lists in Klaviyo. For each list to which you want to send query results, click Lists & Segments. Copy the name of the list into which you want to load query data or provide a new name to create a new list.
Add destination¶
Configure Amperity to send audience lists directly to Klaviyo.
To add a destination
Open the Destinations tab to configure a destination for Klaviyo. Click the Add Destination button to open the Destination dialog box. Enter a name for the destination and provide a description. For example: “Klaviyo” and “This sends audience lists to Klaviyo”. From the Plugin drop-down, start typing “kla” to filter the list, and then select Klaviyo. |
|
Credentials allow Amperity to connect to Klaviyo. The credential type is set automatically. You may use an existing credential or you may add a new one. Select an existing credential from the Credential drop-down. – or – Select Create a new credential from the Credential drop-down. This opens the Credential dialog box. Enter the name for the credential, and then add a description. Enter the Klaviyo API key. Be sure to add the full Klaviyo API key. When finished, click Save. |
|
Each destination has settings that define how Amperity will deliver data to Klaviyo. These settings are listed under the Settings section of the Destination dialog box. |
|
Business users are assigned to the Amp360 User and/or AmpIQ User policies. (Amp360 User allows access to queries and orchestrations and AmpIQ User allows access to segments and campaigns.) A business user cannot select a destination that is not visible to them. Business users – including users assigned to the DataGrid Operator policy – may have restricted access to PII. What is restricted access to PII? Restricted PII access is enabled when the Restrict PII access policy option that prevents users who are assigned to that option from viewing data that is marked as PII anywhere in Amperity and from sending that data to any downstream workflow. You can make this destination visible to orchestrations and allow users with restricted access to PII to use this destination by enabling one (or both) of the following options: Note To allow business users to use this destination with campaigns, you must enable the Available to campaigns option within the data template. This allows users to send campaign results from Amperity to Klaviyo. The other two settings may be configured within the data template instead of the destination. |
|
Review all settings, and then click Save. Important You must configure a data template for this destination before you can send data to Klaviyo. |
Add data template¶
A data template defines how columns in Amperity data structures are sent to downstream workflows. A data template is part of the configuration for sending query and segment results from Amperity to an external location.
To add a data template
From the Destinations tab, open the menu for a destination that is configured for Klaviyo, and then select Add data template. This opens the Add Data Template dialog box. Enter the name of the data template and a description. For example: “Klaviyo” and “Send audience lists to Klaviyo.”. |
|
Verify business user access to queries and orchestrations and access to segments and campaigns. A business user may also have restricted access to PII, which prevents them from viewing and sending customer profile data. If business user access was not configured as part of the destination, you may configure access from the data template. Important To allow business users to use this destination with campaigns, you must enable the Available to campaigns option. This allows users to send campaign results from Amperity to Klaviyo. If you enable this option, the data extension settings require using campaign name and group name template variables to associate the name of the data extension to your campaign. |
|
Verify all configuration settings. Note When the audience list settings were are not configured as part of the destination, you must configure them as part of the data template before making this destination available to campaigns. |
|
Configure how Amperity will send data to Klaviyo. For campaigns Under Template Settings, configure the following settings: List Name This is the name of the audience list in Klaviyo. If the audience list does not exist, this is the name of the audience list that will be created by Amperity. Note By default, Amperity will manage audience lists using only email. For orchestrations When you configure Amperity to send query results to Klaviyo you have two choices:
Under Template Settings, configure the following settings: List Name This is the name of the audience list in Klaviyo. If the audience list does not exist, this is the name of the audience list that will be created by Amperity. Use full profile to update list This option allows queries to send additional customer profile fields as part of the audience list, after which they will be visible in Klaviyo from the Customer Properties section within individual profiles for members of that audience list. Note By default, Amperity will manage audience lists using only email. |
|
Review all settings, and then click Save. After you have saved the data template, and depending on how you configured it, business users can send query results and/or send campaigns to Klaviyo. |
Workflow actions¶
A workflow will occasionally show an error that describes what prevented a workflow from completing successfully. These first appear as alerts in the notifications pane. The alert describes the error, and then links to the Workflows tab.
Open the Workflows page to review a list of workflow actions, choose an action to resolve the workflow error, and then follow the steps that are shown.
You may receive a notifications error for a configured Klaviyo destination. This appears as an alert in the notifications pane on the Destinations tab. If you receive a notification error, review the details, and then click the View Workflow link to open this notification error in the Workflows page. |
|
On the Workflows page, review the individual steps to determine which step(s) have errors that require your attention, and then click Show Resolutions to review the list of workflow actions that were generated for this error. |
|
A list of individual workflow actions are shown. Review the list to identify which action you should take. Some workflow actions are common across workflows and will often be available, such as retrying a specific task within a workflow or restarting a workflow. These types of actions can often resolve an error. In certain cases, actions are specific and are shown when certain conditions exist in your tenant. These types of actions typically must be resolved and may require steps that must be done upstream or downstream from your Amperity workflow. Amperity provides a series of workflow actions that can help resolve specific issues that may arise with Klaviyo, including: |
|
Select a workflow action from the list of actions, and then review the steps for resolving that error. After you have completed the steps in the workflow action, click Continue to rerun the workflow. |
Invalid credentials¶
The credentials that are defined in Amperity are invalid.
To resolve this error, verify that the credentials required by this workflow are valid.
Open the Credentials page.
Review the details for the credentials used with this workflow. Update the credentials for Klaviyo if required.
Return to the workflow action, and then click Resolve to retry this workflow.
Maximum number of lists exceeded¶
Klaviyo supports up to 1000 lists and/or segments in your account at any given time.
To resolve this error, verify the number of lists and/or segments associated with your Klaviyo account.
Log into Klaviyo and verify the number of lists and/or segments that are associated with your Klaviyo account.
Remove unused lists and/or segments.
Return to the workflow action, and then click Resolve to retry this workflow.
Customer profile parameters¶
The following table describes the parameters that may be sent to Klaviyo. Use the properties field to define a series of custom properties (as key/value pairs) to represent offline events.
Amperity uses the Update Profile endpoint in the Klaviyo API to send customer profile attributes to Klaviyo.
The list of customer profile parameters supported by Klaviyo are described in the following table. Parameters are listed alphabetically, but may be returned in any order.
Field name |
Description |
---|---|
address1 |
Optional The address that is associated with the location of a customer, such as “123 Main Street”. |
address2 |
Optional Additional address information, such as an apartment number or a post office box, that is associated with the location of a customer, such as “Apt #9”. |
city |
Optional The city that is associated with the location of a customer. |
country |
Optional The country that is associated with the location of a customer. |
Required The email address that is associated with a customer. A customer may have more than one email address. Important An email address is used by Klaviyo to generate a unique customer identifier for each customer profile that exists within Klaviyo. This email address is most often found in the email field in the Merged Customers table, but may be located elsewhere depending on how your brand has configured your customer 360 database and depending on the downstream use cases your brand wants to enable within Klaviyo. |
|
external_id |
Optional A unique identifier that associates Klaviyo profiles with customer profiles that exist within an external system. For example, a unique ID for a point-of-sale system or the Amperity ID. |
first_name |
Optional The first name that is associated with a customer. |
image |
Optional A URL that points to the location of a profile image for this customer profile. |
ip |
Optional An IP address that is associated with this customer profile. |
last_event_date |
Optional A timestamp for an event that is associated with this customer profile. For example, the date and time of the most recent transaction from your brand’s website or store. |
last_name |
Optional The last name that is associated with a customer. |
latitude |
Optional A latitude coordinate that may be used to define location-based segments in Klaviyo. Note This value should have a precision of four decimal places. |
longitude |
Optional A longitude coordinate that may be used to define location-based segments in Klaviyo. Note This value should have a precision of four decimal places. |
organization |
Optional The company, typically an employer or small business, that is associated with a customer. |
phone_number |
Optional The phone number that is associated with a customer. A customer may have more than one phone number. Note A phone number must be in E.164 format, which represents a phone number as a number up to fifteen digits in length (without spaces) that starts with a + symbol. For example: +12061234567. |
properties |
Optional A series of custom properties represented as key/value pairs for additional data that your brand wants to associate with this customer profile. For example, a store ID or the name (or SKU) of the most recent product purchase associated with this customer profile. |
region |
Optional The state or province that is associated with the location of a customer. |
timezone |
Optional The name of a timezome. Klaviyo recommends using the name of a timezone in the IANA Time Zone Database. |
title |
Optional The title that precedes a full name that is associated with a customer, such as “Mr.”, “Mrs”, and “Dr”. |
zip |
Optional The zip code or postal code that is associated with the location of a customer. |