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
[OneSignal](https://onesignal.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) is the market leader in driving customer engagement with multi-channel messaging across Web and Mobile Push, In-App Messages, SMS, and Email subscribers.
8
8
This destination is maintained by OneSignal. For any issues with the destination, [contact OneSignal Support team](mailto:[email protected]).
9
9
10
-
**Note**: *The OneSignal Destination is currently in beta.*
11
-
This means that OneSignal is still actively developing the destination and some functionality may change before it becomes generally available.
10
+
{% include content/beta-note.md %}
11
+
12
+
## Getting Started
12
13
13
-
# Getting Started
14
-
**Do not remove this line. It will auto-populate the following information for your integration:****https://cl.ly/23e637f055f7
15
14
{% include content/connection-modes.md %}
16
15
17
16
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
18
-
1. Search for "OneSignal" in the Destinations Catalog, and select the "OneSignal" destination.
19
-
1. Choose which Source should send data to the "OneSignal" destination.
20
-
1. Go to the [OneSignal dashboard](https://app.onesignal.com/apps/), select the App and go to the Settings → Keys & IDs. Copy the “App ID” and the “API key”.
21
-
1. Enter the OneSignal “App ID” and the “API key” in the "OneSignal" destination settings in Segment and Enable the App.
22
-
1. Please make sure you have an “[External User ID](https://documentation.onesignal.com/docs/onboarding-with-onesignal#step-3-connect-user-data-to-onesignal)” set for your users on OneSignal. OneSignal uses the “External User ID” to match with the “User ID” value from Segment.com.
17
+
1. Search for OneSignal in the Destinations Catalog, and select the OneSignal destination.
18
+
1. Choose which Source should send data to the OneSignal destination.
19
+
1. Go to the [OneSignal dashboard](https://app.onesignal.com/apps/){:target="_blank"}, select the App and go to the *Settings > Keys & IDs*. Copy the **App ID** and the **API key**.
20
+
1. Enter the OneSignal **App ID** and the **API key** in the OneSignal destination settings in Segment and Enable the destination.
21
+
1. Make sure you have an **[External User ID](https://documentation.onesignal.com/docs/onboarding-with-onesignal#step-3-connect-user-data-to-onesignal)** set for your users on OneSignal. OneSignal uses the **External User ID** to match with the **User ID** value from Segment.
22
+
23
+
> info ""
24
+
> The OneSignal Destination is available customers on OneSignal Professional and Enterprise plans.
25
+
26
+
## Supported methods
27
+
28
+
OneSignal supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
29
+
30
+
### Identify
23
31
24
-
> *OneSignal Destination app is accessible only to customers on OneSignal Professional and Enterprise plans.*
32
+
Send [Identify](/docs/connections/spec/identify) calls to OneSignal. For example:
25
33
26
-
# Identify
27
-
If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like:
These user traits will appear as player [data tags](https://documentation.onesignal.com/docs/add-user-data-tags) in OneSignal.
42
+
These user traits appear as player [data tags](https://documentation.onesignal.com/docs/add-user-data-tags) in OneSignal.
37
43
38
-
*Note:* OneSignal does not accept nested objects or arrays as user properties.
44
+
> warning ""
45
+
> OneSignal does not accept nested objects or arrays as user properties.
39
46
40
47
41
48
42
49
43
50
44
-
# Track
45
-
If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like:
51
+
### Track
52
+
53
+
Send [Track](/docs/connections/spec/track) calls to OneSignal. For example:
54
+
46
55
```js
47
56
analytics.track('Add to Cart', {
48
57
product_name:'Sunglasses',
49
58
brand:'Rayban'
50
59
})
51
60
```
52
61
53
-
For events and associated properties sent using Track call, OneSignal will *drop*the event name (for example, *Add to Cart*), but store all the properties (for example, *productname and brand*) as data tags.
62
+
For events and associated properties sent using a Track call, OneSignal drops the event name (for example, `Add to Cart`), but stores all the properties (for example, `productname` and `brand`) as data tags.
54
63
55
64
56
65
57
66
58
67
59
68
60
-
# Personas
61
-
You can send computed traits and audiences generated using [Segment Personas](https://segment.com/docs/personas) to OneSignal destination. To learn more about Personas, contact us for a [demo](https://segment.com/contact/demo).
69
+
## Personas
70
+
71
+
You can send computed traits and audiences generated using [Segment Personas](/docs/personas) to OneSignal. To learn more about Personas, contact Segment for a [demo](https://segment.com/contact/demo){:target="_blank"}.
62
72
63
73
### Audiences
64
-
Persona Audiences automatically show up as a [segment](https://documentation.onesignal.com/docs/segmentation) in OneSignal.
65
74
66
-
Audiences sent using a **Track call** will create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation) with the *Audience Name*.
75
+
Persona Audiences appear as a [segment](https://documentation.onesignal.com/docs/segmentation) in OneSignal.
76
+
77
+
Audiences sent as part of a Track call create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation) with the Audience Name.
67
78
68
-
Audiences sent using an **Identify call** will
69
-
1. create a OneSignal segment with the *Audience Name* and
70
-
2. add data tags (if there are additional properties in the Identify call) on all the matching user records.
79
+
Audiences sent as part of an Identify call:
80
+
81
+
- Create a OneSignal segment with the Audience Name
82
+
- add data tags (if there are additional properties in the Identify call) on all the matching user records.
71
83
72
84
73
85
74
86
The Identify and Track calls are sent to OneSignal whenever a user enters or exits the Audience.
75
87
76
88
### Computed Traits
77
-
Personas Computed Traits are stored as [Data Tags](https://documentation.onesignal.com/docs/add-user-data-tags) on the OneSignal user (player) records whether passed to OneSignal as an Identify call or a Track call. You can then use these data tags to manually create OneSignal segments and automate your messaging workflows.
78
-
79
89
90
+
Personas Computed Traits are stored as [Data Tags](https://documentation.onesignal.com/docs/add-user-data-tags) on the OneSignal user (player) records whether passed to OneSignal as an Identify call or a Track call. You can then use these data tags to manually create OneSignal segments and automate your messaging workflows.
80
91
81
92
# OneSignal Destination FAQ
82
93
83
94
**Managing Segment’s Reserved and Custom Traits**
84
-
* All the Segment’s user traits are sent to OneSignal as data tags. The number of data tags allowed on OneSignal depends on your OneSignal pricing plan. Tags over the entitled number will be dropped.
85
-
* OneSignal always updates the firstName and the lastName properties for matching users. All other traits are added/updated on a firstcome basis. *firstName* and *lastName* tags are stored as "first_name" and "last_name".
95
+
96
+
* All Segment user traits are sent to OneSignal as data tags. The number of data tags allowed on OneSignal depends on your OneSignal pricing plan. Tags over the entitled number will be dropped.
97
+
98
+
* OneSignal always updates the `firstName` and the `lastName` properties for matching users. All other traits are added/updated on a firstcome basis. `firstName` and `lastName` tags are stored as `first_name` and `last_name`.
99
+
86
100
* User properties sent to OneSignal with blank/null values are removed from the OneSignal user record. This is done to make sure you are within your data tag limits.
101
+
87
102
* OneSignal doesn’t store email and phone properties as these key identifiers are stored as separate player records in OneSignal. To update user traits for these records in OneSignal
88
-
* You must create a player record with the email address and/or a phone number and map those records with the External_User_ID.
89
-
* Additional properties sent from Segment will then be automatically mapped across all your matching records, including email and phone number records.
103
+
* Create a player record with the email address and/or a phone number and map those records with the External_User_ID.
104
+
* Additional properties sent from Segment are mapped across all your matching records, including email and phone number records.
0 commit comments