Setup Guide

Set up and configure OneSignal as a destination in RudderStack.

  •   2 minute read  

This guide will help you set up OneSignal as a destination in the RudderStack dashboard. It also lists the configuration settings required to correctly send data from the supported sources to OneSignal.

Connection compatibility

Destination info
  • Status: Generally Available
  • Supported sources: Android, iOS , Web, Unity, AMP , Cloud, Warehouse, React Native , Flutter, Cordova, Shopify
  • Refer to it as ONE_SIGNAL in the Integrations object.

Connection modes
SourceCloud modeDevice modeHybrid mode
AMPsupportednot supportednot supported
Androidsupportednot supportednot supported
Cloudsupportednot supportednot supported
Cordovasupportednot supportednot supported
Fluttersupportednot supportednot supported
iOSsupportednot supportednot supported
React Nativesupportednot supportednot supported
Shopifysupportednot supportednot supported
Unitysupportednot supportednot supported
Warehousesupportednot supportednot supported
Websupportednot supportednot supported
Supported message types
SourceIdentifyPageScreenTrack
Cloud mode
All sourcessupportednot supportednot supportedsupported

Setup

  1. In your RudderStack dashboard, add a source. Then, from the list of destinations, select OneSignal.
  2. Assign a name to the destination and click Continue.

Connection settings

SettingDescription
App IDEnter your OneSignal App ID.
Event version to useSelect the OneSignal API to use. RudderStack provides the following options:

  • Device Model (Deprecated)
  • User Model (Recommended)
See the OneSignal documentation for more information.
Toggle on to add a device/subscription using emailTurn on this setting to add a new device to your OneSignal app using the email.
Toggle on to add a device/subscription using phone numberToggle on this setting to add a new device to your OneSignal app using the phone number.
Toggle on to concatenate event name with propertiesTurn on this setting to concatenate the event names with properties.

For example, if add_to_cart is an event and brand is a property, the event will be sent as add_to_cart_brand tag.
Allowed Property ListEnter the properties you want to add as device tags, if present in the payload.

Note: RudderStack considers the properties mentioned under this setting only for the track and group calls.
OneTrust Consent CategoriesThis setting lets you associate the OneTrust cookie consent groups to OneSignal.

Next steps

FAQ

Where can I find the OneSignal App ID?

  1. Log in to your OneSignal dashboard.
  2. Go to your app’s Settings > Keys & IDs.
  3. You will find the OneSignal App ID:
OneSignal license code and API key

Questions? Contact us by email or on Slack