Overview

OneSignal is a platform for mobile push notifications, web push, email, and in-app messaging. OneSignal provides a simple interface to push notifications and email, letting content creators focus on quality user engagement instead of complex implementation.

Integrate Lytics and OneSignal to trigger push notifications to users in your rich, cross-channel Lytics audiences. You can import user data from OneSignal such as device details and aggregate activity data for use in your Lytics audiences.

Authorization

If you haven't already done so, you will need to set up a OneSignal account before you begin the process described below. You will need your OneSignal User Auth Key. See OneSignal's Account and Keys documentation for instructions on obtaining your key.

If you are new to creating authorizations in Lytics, see the Authorizations documentation for more information.

Select OneSignal from the list of providers.
Select the OneSignal method for authorization.
Enter a Label to identify your authorization.
(Optional) Enter a Description for further context on your authorization.
Enter your User Auth Key
Click Save Authorization.

onesignal-auth

Import Audiences & Activity Data

Import user data from your Apps in OneSignal such as device details and aggregate activity data for use in your Lytics audiences.

Integration Details

Implementation Type: Server-side Integration.
Implementation Technique: REST API Integration.
Frequency: User data is a Batch Integration, with option of daily continuous updates. By default the import will run every 24 hours.
Resulting data: Users from your Apps on OneSignal.

This integration utilizes the OneSignal API to receive user data. Each run of the job will proceed as follows:

Get the apps as requested.
Filter for valid App IDs.
Get information on users for all apps and place in the Lytics data stream onesignal_users.

Fields

The following fields are included in the default mapping of the onesignal_users stream:

Source Field	Lytics User Field	Description	Type
session_count	session_count	Session Count	int
language	os_language	OneSignal Language	string
timezone	os_timezone	Timezone	int
game_version	os_app_version	App version	string
device_os	os_device_os	Device OS	string
device_type	os_device_type	Device Type	int
device_model	os_device_model	Device Model	string
last_active	os_last_active_ts	Last Active on OneSignal	date
last_active	last_active_ts	Last Active on Any Channel	data
playtime	os_total_time_in_app	Total time in app	int
amount_spent	os_total_amount_spent	Total Amount Spent	float
created_at	os_created_at	Created At	data
invalid_identifier	os_unsubscribed	Unsubscribed	boolean
badge_count	os_badge_count	Badge Count	int
lat	lat	Latitude	float
lon	lon	Longitude	float
country	country	Country	string

Configuration

Follow these steps to set up an import users job for OneSignal. If you are new to creating jobs in Lytics, see the Data Sources documentation for more information.

Select OneSignal from the list of providers.
Select the Import Audiences & Activity Data job type from the list.
Select the Authorization you would like to use or create a new one.
Enter a Label to identify this job you are creating in Lytics.
(Optional) Enter a Description for further context on your job.
Select the Apps to import data from. Apps in the right column will be imported.
Select Keep Updated to import users continuously. The import will run every 24 hours.
Click Start Import.

OneSignal Import Config

Export Audiences

The OneSignal Export Audiences workflow will send audience membership data to OneSignal as tags, which are used to create segments in OneSignal. For more information about tags see the OneSignal Using Data Tags documentation.

The only identifier accepted by OneSignal for export is the OneSignal ID, which will be selected in the configuration form by default if OneSignal data was already imported.

Integration Details

Implementation Type: Server-side Integration
Implementation Technique: REST API Integration.
Frequency: Real-time Integration.
Resulting data: Segments in OneSignal.

This integration utilizes the OneSignal APIs to send user data. Once the user initiates an export, the workflow will:

Take a group of Audiences in Lytics.
Export them to segments in OneSignal.

Fields

By default, Lytics exports the following field to OneSignal.

Lytics User Field	Description	OneSignal Field	Type
os_id	OneSignal Player ID	os_id	string

Configuration

Follow these steps to set up an export of audiences job for OneSignal. If you are new to creating jobs in Lytics, see the Destinations documentation for more information.

Select OneSignal from the list of providers.
Select the Export Audiences job type from the list.
Select the Authorization you would like to use or create a new one.
Enter a Label to identify this job you are creating in Lytics.
(Optional) Enter a Description for further context on your job.
Select the OneSignal Player ID to configure the field that contains OneSignal Player ID.
Select the Audiences to export.
Select Existing Users to complete the workflow with existing users in the selected Lytics audience(s).
Click Start Export.

OneSignal Export Config