Skip to content

Commit 0c7cc45

Browse files
authored
Merge pull request #1794 from segmentio/one-signal-new-updates
Updates to OneSignal New and OneSignal
2 parents 9e390e2 + ce3cdf6 commit 0c7cc45

File tree

1 file changed

+28
-34
lines changed
  • src/connections/destinations/catalog/onesignal-new

1 file changed

+28
-34
lines changed

src/connections/destinations/catalog/onesignal-new/index.md

Lines changed: 28 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,14 @@
22
rewrite: true
33
title: OneSignal New Destination
44
hide-personas-partial: true
5+
redirect_from: '/connections/destinations/catalog/onesignal/'
56
---
67

7-
[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-
This destination is maintained by OneSignal. For any issues with the destination, [contact OneSignal Support team](mailto:[email protected]).
8+
[OneSignal](https://onesignal.com/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank"} is the market leader in driving customer engagement with multi-channel messaging across Web and Mobile Push, In-App Messages, SMS, and Email subscribers.
9+
This destination is maintained by OneSignal. For any issues with the destination, [contact the OneSignal Support team](mailto:[email protected]).
910

10-
{% include content/beta-note.md %}
11+
> info ""
12+
> The OneSignal Destination is available to customers on OneSignal Professional and Enterprise plans.
1113
1214
## Getting Started
1315

@@ -16,20 +18,21 @@ This destination is maintained by OneSignal. For any issues with the destination
1618
1. From the Destinations catalog page in the Segment App, click **Add Destination**.
1719
1. Search for OneSignal in the Destinations Catalog, and select the OneSignal destination.
1820
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.
21+
1. Go to the [OneSignal dashboard](https://app.onesignal.com/apps/){:target="_blank"}, select the Segment App, and go to the **Settings > Keys & IDs**. Copy the **App ID** and the **API key**.
22+
1. Enter the OneSignal **App ID** and the **API key** in the OneSignal destination settings in Segment.
23+
2224

2325
> info ""
24-
> The OneSignal Destination is available customers on OneSignal Professional and Enterprise plans.
26+
> OneSignal maps the `userId` field to the **[External User ID](https://documentation.onesignal.com/docs/onboarding-with-onesignal#step-3-connect-user-data-to-onesignal)** field in OneSignal.
27+
2528

2629
## Supported methods
2730

2831
OneSignal supports the following methods, as specified in the [Segment Spec](/docs/connections/spec).
2932

3033
### Identify
3134

32-
Send [Identify](/docs/connections/spec/identify) calls to OneSignal. For example:
35+
Send [Identify](/docs/connections/spec/identify) calls to update Users. For example:
3336

3437
```js
3538
analytics.identify('userId123', {
@@ -39,18 +42,16 @@ analytics.identify('userId123', {
3942
});
4043
```
4144

42-
These user traits appear as player [data tags](https://documentation.onesignal.com/docs/add-user-data-tags) in OneSignal.
45+
Segment sends Identify traits as [Player Data Tags](https://documentation.onesignal.com/docs/add-user-data-tags) in OneSignal.
4346

4447
> warning ""
45-
> OneSignal does not accept nested objects or arrays as user properties.
48+
> OneSignal doesn't accept nested objects or arrays as user properties.
4649
4750
![](images/demo.png)
4851

49-
50-
5152
### Track
5253

53-
Send [Track](/docs/connections/spec/track) calls to OneSignal. For example:
54+
Send [Track](/docs/connections/spec/track) calls to update Data Tags. For example:
5455

5556
```js
5657
analytics.track('Add to Cart', {
@@ -59,46 +60,39 @@ analytics.track('Add to Cart', {
5960
})
6061
```
6162

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.
63-
64-
![](images/track-example.png)
65-
63+
OneSignal stores Track properties as Data Tags but drops the event name. In the above example, `Add to Cart` is dropped.
6664

65+
To keep the event names on OneSignal Data Tags, append the event name to the properties. For example, `Add_to_Cart_brand` instead of `brand`.
6766

67+
![](images/track-example.png)
6868

6969
## Personas
7070

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"}.
71+
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"}.
7272

7373
### Audiences
7474

75-
Persona Audiences appear as a [segment](https://documentation.onesignal.com/docs/segmentation) in OneSignal.
75+
Personas Audiences appear as a [segment](https://documentation.onesignal.com/docs/segmentation) in OneSignal.
7676

77-
Audiences sent as part of a Track call create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation) with the Audience Name.
77+
Track calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation) with the Audience Name.
7878

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.
79+
Identify calls from Audiences create a OneSignal [segment](https://documentation.onesignal.com/docs/segmentation) with the Audience Name and add Data Tags on all the matching user records.
8380

8481
![](images/audiences.jpg)
8582

86-
The Identify and Track calls are sent to OneSignal whenever a user enters or exits the Audience.
83+
Audiences sends Identify and Track calls to OneSignal when a user enters or exits the Audience.
8784

8885
### Computed Traits
8986

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.
91-
92-
# OneSignal Destination FAQ
87+
OneSignal stores Track and Identify calls from Personas Computed Traits as [Data Tags](https://documentation.onesignal.com/docs/add-user-data-tags) for the OneSignal User/Player's records.
9388

94-
**Managing Segment’s Reserved and Custom Traits**
89+
## OneSignal Destination FAQ
90+
### Managing Segment’s Reserved and Custom Traits
9591

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.
92+
* Segment sends user traits to OneSignal as Data Tags. The number of data tags OneSignal allows depends on your OneSignal pricing plan. OneSignal drops the data tags that go over your set number. .
9793

9894
* 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`.
9995

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.
96+
* Send User properties to OneSignal with blank/null values to remove the corresponding Data Tag from the OneSignal user record.
10197

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
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.
98+
* OneSignal doesn’t store `email` and `phone` properties. To update `email` and `phone` properties in OneSignal, create a player record with the email address and/or a phone number and map those records with the External_User_ID. Additional properties from Segment map across all your matching records, including email and phone number records.

0 commit comments

Comments
 (0)