OneSignal New Destination

OneSignal (New) quick info

OneSignal (New) accepts Identify, and Track calls. If you reference it in the Integrations object, call it “OneSignal New", or "OneSignal (New)”.

OneSignal is the market leader in driving customer engagement with multi-channel messaging across Web and Mobile Push, In-App Messages, SMS, and Email subscribers. This destination is maintained by OneSignal. For any issues with the destination, contact the OneSignal Support team.

The OneSignal Destination is available to customers on OneSignal Professional and Enterprise plans.

Getting Started

  1. Log in to the OneSignal Dashboard
  2. Navigate to Segment App -> Settings -> Analytics -> Segment.com and click Activate.
  3. The Segment App opens in a new window. Log in to authenticate the connection from OneSignal.
  4. Select the Workspace and Source to connect with OneSignal.

OneSignal maps the userId field to the External User ID field in OneSignal.

Supported methods

OneSignal supports the following methods, as specified in the Segment Spec.

Identify

Send Identify calls to update Users. For example:

analytics.identify('userId123', {
  firstName: 'John',
  lastName: 'Doe',
     country: USA
});

Segment sends Identify traits as Player Data Tags in OneSignal.

OneSignal doesn’t accept nested objects or arrays as user properties.

Track

Send Track calls to update Data Tags. For example:

analytics.track('Add to Cart', {
    product_name: 'Sunglasses',
    brand: 'Rayban'
})

OneSignal stores Track properties as Data Tags but drops the event name. In the above example, Add to Cart is dropped.

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.

Personas

Send Computed Traits and Audiences generated using Segment Personas to OneSignal. To learn more about Personas, contact Segment for a demo.

Audiences

Personas Audiences appear as a segment in OneSignal.

Track calls from Audiences create a OneSignal segment with the Audience Name.

Identify calls from Audiences create a OneSignal segment with the Audience Name and add Data Tags on all the matching user records.

Audiences sends Identify and Track calls to OneSignal when a user enters or exits the Audience.

Computed Traits

OneSignal stores Track and Identify calls from Personas Computed Traits as Data Tags for the OneSignal User/Player’s records.

OneSignal Destination FAQ

Managing Segment’s Reserved and Custom Traits

  • 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. .

  • 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.

  • Send User properties to OneSignal with blank/null values to remove the corresponding Data Tag from the OneSignal user record.

  • 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.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
API Key
(required)
string. You can find your API Key in your OneSignal app settings page
App Id
(required)
string. You App Id

Adding OneSignal (New) to the integrations object

To add OneSignal (New) to the integrations JSON object (for example, to filter data from a specific source), use one of the following valid names for this integration:

  • OneSignal New

  • OneSignal (New)

This page was last modified: 02 Sep 2021



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account