Skip to content

Commit cc95d60

Browse files
authored
Merge pull request #6493 from segmentio/thomas/klaviyo-actions
Update klaviyo actions docs
2 parents 6677aff + f82403f commit cc95d60

File tree

1 file changed

+27
-23
lines changed
  • src/connections/destinations/catalog/actions-klaviyo

1 file changed

+27
-23
lines changed

src/connections/destinations/catalog/actions-klaviyo/index.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ id: 650bdf1a62fb34ef0a8058e1
44
beta: true
55
---
66

7-
87
{% include content/plan-grid.md name="actions" %}
98

109
[Klaviyo](https://www.klaviyo.com){:target="_blank"} is a powerful email platform focused on ecommerce that helps companies make more money. It supports segmentation based on category and event triggers like product bought, page viewed, email engagement, or amount spent.
@@ -21,61 +20,66 @@ Klaviyo (Actions) provides the following benefits:
2120
- **More control** - Actions-based destinations enable you to define the mapping between the data Segment receives from your sources, and the data Segment sends to Klaviyo.
2221
- **Default property mappings** - Default mappings from the Segment like event, timestamp, and more, allow data to be mapped correctly without any setup required.
2322

24-
2523
## Getting started
2624

2725
1. From the Segment web app, click **Catalog**.
28-
2. Search for *Klaviyo (Actions)* in the Catalog, select it, and choose which of your sources to connect the destination to.
26+
2. Search for **Klaviyo (Actions)** in the Catalog, select it, and choose which of your sources to connect the destination to.
2927
3. Navigate to [Account > Settings > API Keys](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} in Klaviyo's UI and copy your API Key into the Segment Settings UI.
3028

3129
> info ""
32-
> Klaviyo requires the Private API Key to use the List API. You can find this by going to Klaviyo's UI and clicking [Account > Settings > API Keys > Create API Key](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} to generate a Private API Key and copy it into the Segment Settings UI.
33-
30+
> Klaviyo requires the Private API Key to use the List API. You can find this by going to Klaviyo's UI and clicking [Account > Settings > API Keys > Create API Key](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} to generate a Private API Key and copy it into the Segment Settings UI.
3431
3532
{% include components/actions-fields.html %}
3633

37-
## Using Klaviyo with RETL
34+
## Using Klaviyo with RETL
3835

39-
Klaviyo (Actions) Destination can accept [RETL](/docs/connections/reverse-etl/) data. You can send the models you created in your data warehouse source. Follow [the steps](/docs/connections/reverse-etl/#step-1-add-a-source) to create your data warehouse source and set up models.
36+
Klaviyo (Actions) Destination can accept [RETL](/docs/connections/reverse-etl/) data. You can send the models you created in your data warehouse source. Follow [the steps](/docs/connections/reverse-etl/#step-1-add-a-source) to create your data warehouse source and set up models.
4037

38+
| Action | Added | Updated | Deleted |
39+
| ------------------- | ------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------- |
40+
| Order Completed | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
41+
| Track Event | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
42+
| Upsert Profile | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
43+
| Remove Profile | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/supported.svg" /> |
44+
| Subscribe Profile | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/supported.svg" /> **\*** |
45+
| Unsubscribe Profile | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/supported.svg" /> |
4146

42-
| Action | Added | Updated | Deleted |
43-
| -------------- | --------------- | -------------- | --------------- |
44-
| Order Completed | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
45-
| Track Event | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
46-
| Upsert Profile | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/supported.svg" /> | <img class="inline" src="/docs/images/unsupported.svg" /> |
47+
> info ""
48+
> **\*** Though technically possible, it may not be the most intuitive approach to using RETL.
49+
>
50+
> **e.g.,** Triggering a **Subscribe Profile** action when a user is **deleted** from a Model that queries unsubscribed users.
4751
4852
In order to add users to a list, use the **Upsert Profile** Action and fill out the **List** field with the Klaviyo list to add the profile to.
4953

50-
Follow these steps to create a list in Klaviyo:
54+
Follow these steps to create a list in Klaviyo:
5155

5256
1. Navigate to **Audience > Lists & Segments**.
5357
2. Click **Create List/Segment**.
5458
3. Choose **List**.
5559
4. Give your list a name and add any applicable tags.
5660
5. Click **Create List**.
5761

58-
5962
## Using Klaviyo with Engage
6063

61-
Klaviyo (Actions) Destination can accept your [Engage](/docs/engage/) data. You **don't** need to create a list in Klaviyo. During the first sync, Segment creates a list with the same name as your audience.
64+
Klaviyo (Actions) Destination can accept your [Engage](/docs/engage/) data. If you wish to add a profile to a list associated with the Engage audienceId, you **don't** need to create a list in Klaviyo. During the first sync with the **Add Profile To List (Engage)** Mapping, Segment creates a list with the same ID as your audience.
65+
66+
To add and remove profiles in Klaviyo with Engage Audience data:
6267

63-
To use Klaviyo with Engage:
6468
1. Create and configure your Engage Audience.
6569
2. Navigate to **Engage > Engage Settings > Destinations** and click **Add Destination**.
6670
3. Select **Klaviyo (Actions) Audiences**.
6771
4. Select your Audience Space as the source, and name your destination.
68-
5. On the **Mappings** tab, click **Add Mapping** and select **Add Profile To List**.
69-
6. Click **Save** and make sure to enable the mapping.
70-
7. On the **Mappings** tab, click **Add Mapping** and select **Remove Profile from list**.
71-
8. Click **Save** and make sure you enable the mapping.
72-
9. Enable the destination.
72+
5. On the **Mappings** tab, click **Add Mapping** and select **Add Profile To List (Engage)**.
73+
6. Click **Save** and make sure to enable the mapping.
74+
7. On the **Mappings** tab, click **Add Mapping** and select **Remove Profile from List (Engage)**.
75+
8. Click **Save** and make sure you enable the mapping.
76+
9. Enable the destination.
7377
10. On the **Engage > Audiences > (your audience)** page, click **Add Destination** and select the destination created.
7478
11. In the settings that appear in the side panel, toggle the **Send Track** option on, and don't change the **Audience Entered/Audience Exited** event names.
7579
12. Click **Save Settings**.
7680

77-
## FAQ
81+
## FAQ
7882

79-
### Dealing with 429 Responses from Klaviyo's API
83+
### Dealing with 429 Responses from Klaviyo's API
8084

8185
If you're encountering rate limiting issues, consider enabling batching for the Action receiving these errors. Ensure that within the mapping configuration, "Batch data to Klaviyo" is set to "Yes". This adjustment can help alleviate the rate limiting problem.

0 commit comments

Comments
 (0)