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/vero/index.md
+21-40Lines changed: 21 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,53 +2,47 @@
2
2
title: Vero Destination
3
3
id: 54521fdc25e721e32a72ef03
4
4
---
5
-
Our Vero destination code is all open-source on GitHub if you want to check it out: [JavaScript](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/vero), [Server](https://github.com/segmentio/integration-vero).
5
+
The Vero destination code is all open-source on GitHub if you want to check it out: [JavaScript](https://github.com/segmentio/analytics.js-integrations/tree/master/integrations/vero){:target="_blank"}, [Server](https://github.com/segmentio/integration-vero){:target="_blank"}.
6
6
7
7
## Getting Started
8
8
9
9
Vero helps you send targeted emails to customers based on their behavior.
10
10
11
11
When you enable Vero in the Segment web app, your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading Vero's `m.js` onto your page. This means you should remove Vero's snippet from your page.
12
-
+ Since Vero only records custom events and custom user data, no events or users will appear in Vero until you start using the API outlined below.
13
-
14
-
Vero is supported on the client-side, server-side and mobile.
15
-
16
-
- - -
17
12
13
+
Vero only records custom events and custom user data so no events or users will appear in Vero until you start using the API outlined below.
18
14
19
15
## Identify
20
16
21
-
22
17
### Client Side
23
18
24
-
When you call [`identify`](/docs/connections/spec/identify/) on analytics.js, we augment`traits` to have `traits.id` set to the `userId`, and then call Vero's `user` with the augmented traits object. You should provide both a `traits.email` and a `userId` for Vero to work best.
19
+
When you call [Identify](/docs/connections/spec/identify/) on analytics.js, Segment augments`traits` to have `traits.id` set to the `userId`, and then call Vero's `user` with the augmented traits object. You should provide both a `traits.email` and a `userId` for Vero to work best.
25
20
26
21
If no `email` is attached, the user is created in Vero but cannot be emailed. If you send omit the `userId`, Vero will use the email as the ID, which is is not recommended. Check out the [Vero docs](https://help.getvero.com/workflows/articles/creating-and-matching-vero-customer-ids/){:target="_blank"} for more information.
27
22
28
-
A `userId` is a required value for all types of calls. Be sure you call `identify` with a `userId` for subsequent `track` calls to populate into Vero correctly. For server side calls, you will have to manually pass in the `userId` at the top level.
23
+
A `userId` is a required value for all types of calls. Be sure you call Identify with a `userId` for subsequent `track` calls to populate into Vero correctly. For server side calls, you will have to manually pass in the `userId` at the top level.
29
24
30
25
### Server Side
31
26
32
-
When you call [`identify`](/docs/connections/spec/identify/) from one of our server-side languages, we'll call Vero's REST API and update the traits for the customer with that `userId`. If your `userId` is an email, we'll also set the trait `email` as your `userId` in the update call.
33
-
27
+
When you call [Identify](/docs/connections/spec/identify/) from one of Segment's server-side languages, Segment calls Vero's REST API and update the traits for the customer with that `userId`. If your `userId` is an email, Segment sets the trait `email` as your `userId` in the update call.
34
28
35
29
## Track
36
30
37
-
When you call [`track`](/docs/connections/spec/track/), we'll send the event to Vero with the event `name` and `properties` you provide. Events will be matched to the current user.
31
+
When you call [Track](/docs/connections/spec/track/), Segment sends the event to Vero with the event `name` and `properties` you provide. Events will be matched to the current user.
38
32
39
-
You can also unsubscribe users by sending a `track` event, passing in the user's ID as a `property`, like so:
33
+
You can also unsubscribe users by sending a Track event, passing in the user's ID as a `property`, like so:
40
34
41
35
```javascript
42
36
analytics.track('Unsubscribe', {
43
37
id:'12345'
44
38
});
45
39
```
46
40
47
-
Note: If you'd like to explicitly specify a user's email with track events that is not an event metadata, you can send that under `context.traits.email`!
41
+
Note: If you'd like to explicitly specify a user's email with track events that is not an event metadata, you can send that under `context.traits.email`.
48
42
49
43
## Sending Data from Vero
50
44
51
-
Vero supports sending [email events](/docs/connections/spec/email) to other tools on the Segment platform. These events will be sent as `track` calls to the other destinations you've turned on.
45
+
Vero supports sending [email events](/docs/connections/spec/email) to other tools on the Segment platform. These events will be sent as Track calls to the other destinations you've turned on.
52
46
53
47
To enable this feature,
54
48
@@ -59,20 +53,19 @@ To enable this feature,
59
53
60
54
61
55
62
-
63
56
## Group
64
57
65
-
When you call [`group`](/docs/connections/spec/group/), the `traits` included in the call will be set to the current user's **Group** property in Vero.
58
+
When you call [Group](/docs/connections/spec/group/), the `traits` included in the call will be set to the current user's **Group** property in Vero.
66
59
67
60
## Alias
68
61
69
-
Our [`alias`](/docs/connections/spec/alias/) method can be used from your server to "re-identify" an existing user identity to a new one.
62
+
Segment's [Alias](/docs/connections/spec/alias/) method can be used from your server to "re-identify" an existing user identity to a new one.
70
63
71
64
Most of the time this happens when you identify a visitor by their email address after they opt in, then later re-identify with a database ID when they become registered users.
72
65
73
-
To connect the two identities you'll need to [`alias`](/docs/connections/spec/alias/) their current identity to their new one.
66
+
To connect the two identities you'll need to [Alias](/docs/connections/spec/alias/) their current identity to their new one.
74
67
75
-
Here's a python example of using [`alias`](/docs/connections/spec/alias/) to update the identity from an email address to a database ID:
68
+
Here's a python example of using [Alias](/docs/connections/spec/alias/) to update the identity from an email address to a database ID:
The destination is capable of both adding and removing tags in Vero for a given user. Because `tags` is not a common property of events, this functionality is invoked using an [destination specific option](/docs/connections/sources/catalog/libraries/website/javascript/#selecting-destinations-with-the-integrations-object).
78
+
The destination is capable of both adding and removing tags in Vero for a given user. Because `tags` is not a common property of events, this functionality is invoked using an [destination specific option](/docs/connections/sources/catalog/libraries/website/javascript/#managing-data-flow-with-the-integrations-object).
86
79
87
80
To start using this feature, pass an object called `tags` with the following properties:
88
81
89
-
<table>
90
-
<tr>
91
-
<td>`id` optional</td>
92
-
<td>String</td>
93
-
<td>The user Id to associate tags with. If this is not specified, the destination will simply use the userId from the event itself.</td>
94
-
</tr>
95
-
<tr>
96
-
<td>`action` required</td>
97
-
<td>String</td>
98
-
<td>Must be either 'add' or 'remove'. Indicates whether you would like to add or remove the tags for the given user.</td>
99
-
</tr>
100
-
<tr>
101
-
<td>`values` required</td>
102
-
<td>Array</td>
103
-
<td>An array of strings representing the tags to either add or remove.<td>
|`id`|_optional_| String | The user Id to associate tags with. If this is not specified, the destination will simply use the userId from the event itself. |
85
+
|`action`|_required_| String | Must be either 'add' or 'remove'. Indicates whether you would like to add or remove the tags for the given user. |
86
+
|`values`|_required_| Array | An array of strings representing the tags to either add or remove. |
87
+
88
+
Here is an example using Segment's Node.js library:
0 commit comments