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/actions-facebook-conversions-api/index.md
+4Lines changed: 4 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -211,3 +211,7 @@ After you start sending events, you should start seeing them in twenty minutes.
211
211
2. Click on the corresponding pixel.
212
212
3. In the Overview tab, look for events where the “Connection Method” is Server.
213
213
214
+
### Send multiple External IDs
215
+
216
+
[Facebook](https://developers.facebook.com/docs/marketing-api/conversions-api/parameters/external-id/){:target="_blank"} allows you to send one External ID per payload as a string, or multiple per payload in an array of External ID strings. Send an array of External IDs through Segment by mapping an array to the `externalId` field when setting up your Actions mappings.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/insider/index.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
rewrite: true
3
3
title: Insider Destination
4
4
id: 5f2cf019edbedc752d668f69
5
+
hidden: true
5
6
hide-personas-partial: true
6
7
---
7
8
[Insider](https://useinsider.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) Growth Management Platform (GMP) helps digital marketers drive growth across the funnel. Insider GMP helps marketers deliver personalized journeys across the web, mobile web, mobile apps, messaging, email, and ad channels using the unified data.
Copy file name to clipboardExpand all lines: src/connections/destinations/catalog/vero/index.md
+21-40Lines changed: 21 additions & 40 deletions
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:
Copy file name to clipboardExpand all lines: src/connections/rate-limits.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ Events ingested by Segment have a limit of **10,000** properties per individual
9
9
10
10
## Inbound data ingestion API rate limit
11
11
12
-
If any sources send more than 20,000 events per second without prior arrangement, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed this limit.
12
+
If any sources send more than 20,000 events per second in a workspace without prior arrangement, Segment reserves the right to queue any additional events and process those at a rate that doesn't exceed this limit. To request a higher limit, contact [Segment](mailto:[email protected]).
13
13
14
14
> warning "Engage rate limit"
15
15
> Engage has a limit of 1,000 events per second for inbound data. Visit the [Engage Default Limits documentation](/docs/engage/product-limits/) to learn more.
Copy file name to clipboardExpand all lines: src/connections/reverse-etl/index.md
+17-15Lines changed: 17 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -96,32 +96,34 @@ To create a mapping:
96
96
1. Navigate to **Conections > Destinations** and select the **Reverse ETL** tab.
97
97
2. Select the destination that you want to create a mapping for.
98
98
3. Click **Add Mapping**.
99
-
2. Select the model to sync from.
100
-
3. Select the **Action** you want to sync and click **Next**.
99
+
4. Select the model to sync from.
100
+
5. Select the **Action** you want to sync and click **Next**.
101
101
* Actions determine the information sent to the destination. The list of Actions will be unique to each destination.
102
-
4. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
102
+
6. In the **Select record to map and send** section, select which records to send to your destination after Segment completes extracting data based on your model. You can choose from:
103
103
* Added records
104
104
* Updated records
105
105
* Added or updated records
106
106
* Deleted records
107
-
5. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
108
-
6. Select the **Schedule type** for the times you want the data to be extracted from your warehouse. You can choose from:
107
+
7. Select a test record to preview the fields that you can map to your destination in the **Add test record** field.
108
+
8. Select the Schedule type for the times you want the model’s data to be extracted from your warehouse. You can choose from:
109
109
***Interval**: Extractions perform based on a selected time cycle.
110
110
***Day and time**: Extractions perform at specific times on selected days of the week.
111
-
7. Select how often you want the schedule to sync in **Schedule configuration**.
111
+
9. Select how often you want the schedule to sync in **Schedule configuration**.
112
112
* For an **Interval** schedule type, you can choose from: 15 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 6 hours, 8 hours, 12 hours, 1 day.
113
113
* 15 minutes is considered real-time for warehouse syncs
114
-
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time. You can only choose to sync the extraction at the top of the hour.
115
-
8. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
116
-
* You map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected.
117
-
* If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](#supported-object-and-arrays).
118
-
9.*(Optional)* Send a test record to verify the mappings correctly send to your destination.
119
-
9. Click **Save Mapping**.
120
-
10. Select the destination you’d like to enable the mapping for under **Connections > Destinations > Reverse ETL**.
121
-
11. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
114
+
* For a **Day and time** schedule type, you can choose the day(s) you’d like the schedule to sync as well as the time.
115
+
* You can only choose to start the extraction at the top of the hour.
116
+
* Scheduling multiple extractions to start at the same time inside the same data warehouse causes extraction errors.
117
+
10. Define how to map the record columns from your model to your destination in the **Select Mappings** section.
118
+
* You map the fields that come from your source, to fields that the destination expects to find. Fields on the destination side depend on the type of action selected.
119
+
* If you're setting up a destination action, depending on the destination, some mapping fields may require data to be in the form of an object or array. See the [supported objects and arrays for mapping](#supported-object-and-arrays).
120
+
11.*(Optional)* Send a test record to verify the mappings correctly send to your destination.
121
+
12. Click **Create Mapping**.
122
+
13. Select the destination you’d like to enable on the **My Destinations** page under **Reverse ETL > Destinations**.
123
+
14. Turn the toggle on for the **Mapping Status**. Events that match the trigger condition in the mapping will be sent to the destination.
122
124
* If you disable the mapping state to the destination, events that match the trigger condition in the mapping won’t be sent to the destination.
123
125
124
-
To add multiple mappings from your warehouse to your destination, repeat steps 1-9 above.
126
+
To add multiple mappings from your warehouse to your destination, repeat steps 1-13 above.
125
127
126
128
## Using Reverse ETL
127
129
After you've followed [all four steps](/docs/connections/reverse-etl/#getting-started) and set up your source, model, destination, and mappings for Reverse ETL, your data will extract and sync to your destination(s) right away if you chose an interval schedule. If you set your data to extract at a specific day and time, the extraction will take place then.
0 commit comments