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/startdeliver-v2/index.md
+19-20Lines changed: 19 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,34 +8,33 @@ beta: true
8
8
Startdeliver maintains this destination. For any issues with the destination, [contact their support team](mailto:[email protected]).
9
9
10
10
11
-
## Getting Started
11
+
## Getting started
12
12
13
13
14
14
15
15
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
16
-
2. Search for "Startdeliver" in the Destinations Catalog, and select the "Startdeliver" destination.
17
-
3. Choose which Source should send data to the "Startdeliver" destination.
18
-
4. Go to the [API keys](https://app.startdeliver.com/settings/apikeys){:target="_blank"} in your Startdeliver dashboard, generate an API key, make it active and grant it "Admin" permissions.
19
-
5. Enter the "API Key" in the "Startdeliver" destination settings in Segment.
20
-
6. Create a User custom field you want to match a Segment event on [here](https://app.startdeliver.com/settings/fields){:target="_blank"}. You will need a field's alias at the next step.
21
-
7. Enter the "Startdeliver user custom field to match on" in the "Startdeliver" destination settings in Segment.
22
-
16
+
2. Search for **Startdeliver** in the Destinations Catalog, and select the **Startdeliver** destination.
17
+
3. Choose which source should send data to the Startdeliver destination.
18
+
4. Go to the [API keys](https://app.startdeliver.com/settings/apikeys){:target="_blank"} in your Startdeliver dashboard, generate an API key, make it active and grant it admin permissions.
19
+
5. Enter the API Key in the Startdeliver destination settings in Segment.
20
+
6. Create a User custom field you want to match a Segment event on [in your settings](https://app.startdeliver.com/settings/fields){:target="_blank"}. You will need a field's alias during the next step.
21
+
7. Enter the Startdeliver user custom field to match on in the Startdeliver destination settings in Segment.
23
22
24
23
You have to [identify](/docs/connections/spec/identify/) your user with a proper `userId` so that Startdeliver can match your Segments events with correct Startdeliver users.
25
24
26
-
Startdeliver attaches any matched events to existing users. If no matched users are found, Startdeliver creates a new user. Startdeliver uses a custom field you specified at the 7th step of the "Getting Started" section to match a user.
25
+
Startdeliver attaches any matched events to existing users. If no matched users are found, Startdeliver creates a new user. Startdeliver uses a custom field you specified during the seventh step of the Getting Started section to match a user.
27
26
28
27
For example, you have a user in Startdeliver and you want to attach your Segment events to that user.
29
28
30
-
To do this, create a User custom field. For instance, it could be`externalId`. Now you should update your Startdeliver user with a proper value, for example, `97980cfea0067` (this is your user's ID). Don't forget to set this custom field in 7th step of the "Getting Started" section.
29
+
To do this, create a User custom field, like`externalId`. Now you should update your Startdeliver user with a proper value, for example, `97980cfea0067` (this is your user's ID). Don't forget to set this custom field in 7th step of the "Getting Started" section.
31
30
32
-
Now when this user goes to your app, you should [identify](/docs/connections/spec/identify/) them:
31
+
When this user goes to your app, you should [identify](/docs/connections/spec/identify/) them:
33
32
34
33
```js
35
34
analytics.identify('97980cfea0067')
36
35
```
37
36
38
-
After this, you can send either `Page` or `Track` events:
37
+
After this, you can send either Page or Track events:
39
38
40
39
```js
41
40
analytics.track('Login Button Clicked')
@@ -45,7 +44,7 @@ This event is matched with a Startdeliver user that has ID `97980cfea0067` set i
45
44
46
45
Segment events will appear on Customer and User views in Startdeliver. The views will be created instantly within Startdeliver.
47
46
48
-
For further information you can check[Startdeliver documentation](https://app.startdeliver.com/dev/app/Segment){:target="_blank"}.
47
+
For more information, view the[Startdeliver documentation](https://app.startdeliver.com/dev/app/Segment){:target="_blank"}.
49
48
50
49
51
50
## Page
@@ -81,18 +80,18 @@ Segment sends Track calls to Startdeliver as a `track` event.
81
80
82
81
## Identify & Group
83
82
84
-
To enable parsing of Identify and Group events in Startdeliver you have to enable it in the [Segment app configuration in your Startdeliver-account](https://app.startdeliver.com/settings/app/segment).
83
+
To enable parsing of Identify and Group events in Startdeliver, you have to enable it in the [Segment app configuration in your Startdeliver-account](https://app.startdeliver.com/settings/app/segment){:target="_blank"}.
85
84
86
-
In order for us to properly manage Identify and Group events you are also required to configure the Matching and Mapping variables in Startdeliver settings in order to choose which fields should map to a User or a Customer respectively when these events are received. If a User or a Customer is found based on these parameters it will be updated or otherwise created in Startdeliver.
85
+
For Startdeliver to manage Identify and Group events, you must configure the Matching and Mapping variables in Startdeliver settings in order to choose which fields should map to a User or a Customer respectively when these events are received. If a User or a Customer is found based on these parameters it will be updated or otherwise created in Startdeliver.
87
86
88
-
The configuration is cached for 10 minutes so any changes made in the configuration will take up to 10 minutes to update.
87
+
The configuration is cached for 10 minutes, so any changes made in the configuration will take up to 10 minutes to update.
89
88
90
-
`startdeliverMatchingField`Should contain an object with a Field alias that you wish to match your User towards in Startdeliver, as well as a target format type.
89
+
`startdeliverMatchingField`should contain an object with a Field alias that you want to match your User towards in Startdeliver, as well as a target format type.
91
90
`externalMatchingField` should be the field name from which the value will be matched towards the field above.
92
91
93
-
The same thing goes for `startdeliverCustomerField` and `externalCustomerField` if you have any Customer data that you wish to use to connect the user to a customer, as well as update or create a customer in Startdeliver.
92
+
This also applies to `startdeliverCustomerField` and `externalCustomerField` if you have any Customer data that you want to use to connect the user to a customer, as well as update or create a customer in Startdeliver.
94
93
95
-
`userMappnig` and `customerMapping` contains any field values that you wish to append to your User or Customer respectively. This array of objects should contain a Target field-alias, source-field alias as well as a Target-type.
94
+
`userMapping` and `customerMapping` contains any field values that you want to append to your User or Customer respectively. This array of objects should contain a Target field-alias, source-field alias as well as a Target-type.
96
95
97
96
```js
98
97
{
@@ -135,4 +134,4 @@ The same thing goes for `startdeliverCustomerField` and `externalCustomerField`
0 commit comments