OneSignal New Destination

Destination Info

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 Growth, Professional and Enterprise plans.

Getting Started

  1. Log in to the OneSignal Dashboard
  2. Navigate to Segment App -> Settings -> Analytics -> 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.


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.

Data Tag Limits

Your OneSignal plan may cap incoming Data Tags. Once you’ve reached your Data Tag limit, your user traits won’t update in your OneSignal destination.


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.


Send Computed Traits and Audiences generated using Engage to OneSignal


Engage 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 Engage 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 first-come 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.


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

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

This page was last modified: 27 Sep 2022

Get started with Segment

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