OneSignal Help & Documentation

Welcome to the OneSignal New IA developer hub. You'll find comprehensive guides and documentation to help you start working with OneSignal New IA as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Discussions

Segment.com

Integrating OneSignal as a Destination with Segment

Segment.com is a data platform used by businesses to collect user data from their web and mobile apps. Segment then sends the user data to destinations such as OneSignal to create more effective and personalized marketing campaigns.

📘

We currently only support sending data from Segment to OneSignal.

Coming Soon - Sending OneSignal events to Segment

The current integration with Segment enables the use of OneSignal as a Destination. OneSignal accepts data from any Segment web, mobile, or server source in cloud mode.

Requirements

  • Pricing Plan - Segment Integration is available only to customers on the Professional and Enterprise OneSignal plans.
  • OneSignal SDK on the application (web or ios or android) from which you want to send Segment data.
  • External User Ids: Make sure you have “External_User_ID” set for your users. OneSignal uses the “External User ID” to match with the “User ID” field from Segment.com.

Integration Steps

App Setup with OneSignal SDKs

Use an existing app that has OneSignal setup OR Create a new one on OneSignal. Below are the detailed app setup instructions.

Please make sure you have your push, email, or SMS subscribers in OneSignal as well.

Copy OneSignal App Id and API Key

Go to the OneSignal dashboard, select the App, and go to the Settings → Keys & IDs. Copy the “App ID” and the “API key”.

Add OneSignal as a Destination on Segment

  • Find "OneSignal" in Segment's Destination Catalog.
  • Add OneSignal App ID and API Key and Turn on the configuration

Sending Data from Segment to OneSignal

User Mapping

  • OneSignal requires you to have a player (subscriber) already created on OneSignal using our SDKs, APIs, or CSV Upload.
  • You need to have the External User Id field set for the users to match with the User ID field sent by Segment.

🚧

External User ID is mandatory!!

Records that don't have a Segment User ID <--> OneSignal External User ID mapping will be dropped.

Type of Segment data sent to OneSignal

OneSignal Destination can receive the following data from Segment in real-time:

1. User Traits or Properties

You can aggregate data across every customer touchpoint in Segment and then send these user properties in real-time to OneSignal as Data Tags.

Note: OneSignal can not accept nested objects or arrays as user properties.

  • Identify call - User traits or properties sent using Segment's Identify call are stored as data tags on OneSignal.
  • Track call - For events and associated properties sent using Segment's Track call, OneSignal will drop the event name and store all the user properties as data tags.

2. Personas Audience and Computed Traits

Persona Audiences automatically show up as a segment in OneSignal.

Computed traits are updated as Data Tags on the OneSignal user (player) records.

Audience

Audiences sent using Segment's Track call will create a OneSignal segment with the Audience Name.

Audiences sent using Segment's Identify call will

  • create a OneSignal segment with the Audience Name and
  • add data tags (if there are additional properties in the Identify call) on all the matching user records.

The Identify and Track calls are automatically sent to OneSignal whenever a user enters or exits the Audience.

Computed Traits
Personas Computed Traits are stored as 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.


OneSignal Destination FAQs

Managing Segment’s Reserved and Custom User Properties in OneSignal

  • 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.
  • 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".
  • 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.
  • 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, you must create a player record with the email address and/or a phone number and map those records with the External_User_ID.

Updated 7 days ago


Segment.com


Integrating OneSignal as a Destination with Segment

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.