You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/klaviyo/index.md
+46-45Lines changed: 46 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,41 +1,41 @@
1
1
---
2
2
title: Klaviyo Destination
3
3
rewrite: true
4
+
cmode-override: true
4
5
---
5
6
6
7
[Klaviyo](https://www.klaviyo.com/features/overview) 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.
7
8
8
-
It measures opens, clicks, revenue generated, breakdown of generated revenue based on custom attributes (like type of campaign or amount gained per recipient), and provides trend reports, cohort analysis, and subscriber growth
9
+
It measures opens, clicks, revenue generated, breakdown of generated revenue based on custom attributes (like campaign type or amount gained per recipient), and provides trend reports, cohort analysis, and subscriber growth
9
10
10
-
Ultimately, Klaviyo lets you send personalized newsletters, automates triggered emails, product recommendations, welcome campaigns, order announcements, push notifications and sync your data to facebook custom audiences.
11
+
Ultimately, Klaviyo lets you send personalized newsletters, automates triggered emails, product recommendations, welcome campaigns, order announcements, push notifications and sync your data to Facebook custom audiences.
11
12
12
-
Are you trying to set up Klaviyo as an Event Source to get data into your warehouse or other downstream tools? Go [here](https://segment.com/docs/connections/sources/catalog/cloud-apps/klaviyo/).
13
-
14
-
This document was last updated on September 6, 2018. If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)!
13
+
To configure Klaviyo as an Event Source to get data into your warehouse or other downstream tools, see the [Klaviyo Source](/docs/connections/sources/catalog/cloud-apps/klaviyo/) documentation.
15
14
16
15
## Getting Started
17
16
18
17
{% include content/connection-modes.md %}
19
18
20
19
1. From the Segment web app, click **Catalog**.
21
20
2. Search for "Klaviyo" in the Catalog, select it, and choose which of your sources to connect the destination to.
22
-
3. Navigate to your [Account > Settings > API Keys](https://www.klaviyo.com/account#api-keys-tab) in the Klaviyo's UI and copy your "API Key" into the Segment Settings UI.
23
-
5.**Note:** Private API Key is required 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) in order to generate a Private API Key and copy it into the Segment Settings UI.
21
+
3. Navigate to your [Account > Settings > API Keys](https://www.klaviyo.com/account#api-keys-tab){:target="_blank"} in the Klaviyo's UI and copy your "API Key" into the Segment Settings UI.
22
+
4.**Note:**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.
24
23
25
24
26
25
## Page
27
26
28
-
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](https://segment.com/docs/connections/spec/page/) does. An example call would look like:
27
+
If you're not familiar with the Segment Specs, take a look to understand what the [Page method](/docs/connections/spec/page/) does. An example call would look like:
29
28
30
29
```
31
30
analytics.page();
32
31
```
33
32
34
-
**NOTE**: `page` calls are only supported client-side on analytics.js.
33
+
> info ""
34
+
> `page` calls are supported client-side on analytics.js.
35
35
36
36
## Identify
37
37
38
-
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](https://segment.com/docs/connections/spec/identify/) does. An example call would look like:
38
+
If you're not familiar with the Segment Specs, take a look to understand what the [Identify method](/docs/connections/spec/identify/) does. An example call would look like:
39
39
40
40
```
41
41
analytics.identify({
@@ -49,41 +49,42 @@ analytics.identify({
49
49
50
50
### Client side Identify
51
51
52
-
When you call `identify` on analytics.js, we call Klaviyo's `identify` with the `traits` object. We augment the `traits` object to have `traits.$id` be the `userId` since Klaviyo takes the user ID on the `traits` object itself.
52
+
When you call `identify` on analytics.js, Segment calls Klaviyo's `identify` with the `traits` object. Segment then augments the `traits` object to have `traits.$id` be the `userId` since Klaviyo takes the user ID on the `traits` object itself.
53
53
54
-
**Note:** When sending data to Klaviyo using `analytics.js`, an initial `page` call is required. By default, this is already added in your [Segment snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet).
54
+
> info ""
55
+
> When you send data to Klaviyo using `analytics.js`, an initial `page` call is required. By default, this is already added in your [Segment snippet](/docs/connections/sources/catalog/libraries/website/javascript/quickstart/#step-2-copy-the-segment-snippet).
55
56
56
-
We will map the following Segment spec'd traits to Klaviyo [special people properties](http://www.klaviyo.com/docs):
57
+
The following Segment spec'd traits map to Klaviyo [special people properties](http://www.klaviyo.com/docs):
57
58
58
-
|**Segment Traits | Klaviyo Traits**|
59
-
|------ | ------- |
60
-
|`userId`|`$id`|
61
-
|`email`|`$email`|
62
-
|`phoneNumber`|`$phone_number`|
63
-
|`firstName`|`$first_name`|
64
-
|`lastName`|`$last_name`|
65
-
|`title`|`$title`|
59
+
| Segment Traits | Klaviyo Traits|
60
+
| --------------|--------------- |
61
+
|`userId`|`$id`|
62
+
|`email`|`$email`|
63
+
|`phoneNumber`|`$phone_number`|
64
+
|`firstName`|`$first_name`|
65
+
|`lastName`|`$last_name`|
66
+
|`title`|`$title`|
66
67
67
68
### Server side Identify
68
69
69
-
When you call `identify` from one of our mobile or server-side libraries, we will create/update a Klaviyo person with the `traits` you provide in the `identify`.
70
-
71
-
If your `userId` is an email, or you provide an email in `traits.email`, we'll send it as the `$email` property to Klaviyo. We will map the following Segment spec'd traits to Klaviyo [special people properties](http://www.klaviyo.com/docs):
72
-
73
-
|**Segment Traits | Klaviyo Properties**|
74
-
|------ | ------- |
75
-
|`userId`|`$id`|
76
-
|`email`|`$email`|
77
-
|`phoneNumber`|`$phone_number`|
78
-
|`organization`|`$organization`|
79
-
|`firstName`|`$first_name`|
80
-
|`lastName`|`$last_name`|
81
-
|`title`|`$title`|
82
-
|`city`|`$city`|
83
-
|`region` or `state`|`$region`|
84
-
|`country`|`$country`|
85
-
|`timezone`|`$timezone`|
86
-
|`zip`|`$zip`|
70
+
When you call `identify` from a mobile or server-side library, Segment creates or updates a Klaviyo person with the `traits` you provide in the `identify`.
71
+
72
+
If your `userId` is an email, or you provide an email in `traits.email`, Segment sends it as the `$email` property to Klaviyo. The following Segment spec'd traits map to Klaviyo [special people properties](http://www.klaviyo.com/docs):
73
+
74
+
| Segment Traits | Klaviyo Properties |
75
+
| -------------------|------------------ |
76
+
|`userId`|`$id`|
77
+
|`email`|`$email`|
78
+
|`phoneNumber`|`$phone_number`|
79
+
|`organization`|`$organization`|
80
+
|`firstName`|`$first_name`|
81
+
|`lastName`|`$last_name`|
82
+
|`title`|`$title`|
83
+
|`city`|`$city`|
84
+
|`region` or `state`|`$region`|
85
+
|`country`|`$country`|
86
+
|`timezone`|`$timezone`|
87
+
|`zip`|`$zip`|
87
88
88
89
#### Enforce Email as Primary Identifier
89
90
@@ -161,15 +162,15 @@ We will also map the following Segment spec'd properties to Klaviyo's [special p
161
162
The below table shows the out of the box mappings in our integration between our e-commerce spec and Klaviyo's spec:
162
163
163
164
|**Segment Ecommerce Spec | Klaviyo Standard Event**|
Copy file name to clipboardExpand all lines: src/connections/sources/catalog/libraries/website/javascript/upgrade-to-ajs2.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Upgrade to Analytics.js 2.0
3
3
strat: ajs
4
4
---
5
5
6
-
Analytics.js 2.0 is fully backward compatible with Analytics.js Classic when using the default Segment snippet. To upgrade your sources, follow the manual upgrade steps below, or see the schedule for automatic migration. As with all upgrades, Segment recommends that you start development on a non-production source to test the upgrade process and outcome, prior to upgrading your production sources.
6
+
Analytics.js 2.0 is fully backward compatible with Analytics.js Classic when you use the default Segment snippet in a standard implementation. To upgrade your sources, follow the manual upgrade steps below, or see the schedule for automatic migration. As with all upgrades, Segment recommends that you start development on a non-production source to test the upgrade process and outcome, prior to upgrading your production sources.
Copy file name to clipboardExpand all lines: src/connections/spec/common.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -255,7 +255,7 @@ Other libraries only collect `context.library`, any other context variables must
255
255
| library.name | √ | √ | √ |
256
256
| library.version | √ | √ | √ |
257
257
| ip*| √ | √ | √ |
258
-
| locale || √ | √ |
258
+
| locale |√| √ | √ |
259
259
| location.latitude ||||
260
260
| location.longitude ||||
261
261
| location.speed ||||
@@ -282,7 +282,7 @@ Other libraries only collect `context.library`, any other context variables must
282
282
283
283
## Integrations
284
284
285
-
A dictionary of destination names that the message should be sent to. `'All'` is a special key that applies when no key for a specific destination is found.
285
+
A dictionary of destination names that the message should be sent to. `'All'` is a special key that applies when no key for a specific destinatio n is found.
Subscription Functions allow you to write custom JavaScript code that sends Segment Event Data to existing APIs. This guides explains how to write custom functions.
7
7
8
+
> note ""
9
+
> **NOTE:** On July 31, 2021 support for building Subscription Functions will be removed from Developer Center. You may continue building a Subscription Webhook. Segment is committed to improving the Developer Center experience with Developer Center 2.0, which will offer a more holistic approach to building on Segment. If you’re interested in joining the beta in the coming months, please fill out [this form](https://airtable.com/shrvZzQ6NTTwsc6rQ){:target="_blank"}.
10
+
11
+
8
12
## Getting Started
9
13
10
14
Review the steps outlined in the [Developer Center Overview](/docs/partners). This document outlines specific details for Step 4 as it relates to building a Subscription Function.
Copy file name to clipboardExpand all lines: src/partners/subscriptions/index.md
+3Lines changed: 3 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -21,6 +21,9 @@ Review the steps outlined in the [Developer Center Overview](/docs/partners). Th
21
21
22
22
## Build & Test
23
23
24
+
> note ""
25
+
> **NOTE:** On July 31, 2021 support for building Subscription Functions will be removed from Developer Center. You may continue building a Subscription Webhook. Segment is committed to improving the Developer Center experience with Developer Center 2.0, which will offer a more holistic approach to building on Segment. If you’re interested in joining the beta in the coming months, please fill out [this form](https://airtable.com/shrvZzQ6NTTwsc6rQ){:target="_blank"}.
26
+
24
27
You can subscribe to customer data in two ways:
25
28
26
29
1.**[Webhook](/docs/partners/subscriptions/build-webhook)**: Build a new HTTP service that receives Webhook POSTs from Segment.
0 commit comments