OneSignal Source


Good to know: Event Cloud source

The OneSignal Source is an event source. This means that it sends data as events, which are behaviors or occurrences tied to a user and a point in time. Data from these sources can be loaded into your Segment warehouses, and also sent to Segment streaming destinations. Learn more about cloud sources.

OneSignal is designed to help you send notifications and seamlessly manage your user communication across every channel, including mobile push notifications, web push notifications, in-app messaging, bulk SMS, and email. The OneSignal platform is quick to set up and makes it easy to customize and automate your messaging strategy without doing any development work.

OneSignal maintains this source. For any issues with the source, contact the OneSignal Support team

Getting started

  1. From your workspace’s Sources catalog page, search for OneSignal and then click on the OneSignal Source Tile.
  2. On the OneSignal Source Catalog page, click Add Source.
  3. Give the source a name, for example OneSignal_Prod. The name is used in the Segment interface. Click Add source to save your settings.
  4. Copy the write key from your Segment workspace.
  5. Log in to the OneSignal Dashboard.
  6. Navigate to enable the integration: Settings > Integrations > Segment.com and click Activate.
  7. Scroll down to the Data Out panel and enter your write key from your Segment workspace.
  8. Select the OneSignal Events you want to export, then click Save.

Exercise caution when sending Email Sent, SMS Sent, Push Sent and In App Message Displayed events to Segment, as these events can contribute significantly to your Segment MTU usage volume.

You are now all set to sync events from OneSignal to your Segment workspace.

Stream

OneSignal uses Segment’s stream source component to send events to Segment. These events are then available in any destination that accepts server-side events, including your data warehouse.

By default, OneSignal passes the user-level identifiers OneSignal ID (set by OneSignal) and External ID (set by customers), as well as the subscription-level identifier Subscription ID (set by OneSignal) with each event.

Events with no External ID present are anonymous events.

Identifiers

The events OneSignal sends to Segment are identifiers with either userId or anonymousId.

OneSignal sets the Segment userId equal to the OneSignal External ID. If there is no OneSignal External ID for the user, OneSignal sets the Segment anonymousId equal to the OneSignal Subscription ID.

OneSignal doesn’t send user email address or phone number details to Segment.

Events

The following table lists the events that OneSignal sends to Segment. These events appear as tables in your warehouse and as regular events in other destinations.

MessageEvent Kind Event Description
Push Sent Push notification successfully sent
Push Received Push notification successfully received
Push Clicked Push notification touched on device
In-App Message Impression In-App Message successfully displayed on device
In-App Message Clicked In-App Message clicked on device
In-App Message Page Displayed In-App Message page is displayed
Email Sent Email successfully sent
Email Received Email received by recipient
Email Opened Email opened by recipient
Email Link Clicked Email contained link, link clicked
Email Unsubscribed Email unsubscribed by recipient
Email Reported As Spam Email reported as spam by recipient
Email Bounced Email returned to sender due to permanent error
Email Failed Could not deliver the email to the recipient’s inbox
Email Suppressed Email is suppressed for a subscription
SMS Sent SMS sent to recipient
SMS Failed SMS failed to send
SMS Delivered SMS successfully delivered
SMS Undelivered SMS undelivered for a subscription

Event properties

The following table lists the properties included in the events from the Events table.

Property Name Description
userId The external_id associated with the message
anonymousId The subscription_id associated with the message (only sent if there is no external_id)
messageId The identifier of the discrete message
campaign_id The identifier of the message campaign
message_name The message name
message_title The message title only for push and email
message_contents The message contents only for push and sms
template_id The message template used
subscription_id The OneSignal set device/email/sms identifier
subscription_device_type The device type that received the message
language The two character language code of the device
message_type The type of message sent (push, in-app, email, or SMS)

Adding destinations

Now that your source is set up, you can connect it with Destinations.

Log in to your downstream tools and check to see that your events appear as expected. Ensure the events contain all of the properties you expect. If your events and properties don’t appear, check the Event Delivery tool, and refer to the Destination docs for each tool for troubleshooting.

If there are any issues with how the events are arriving to Segment, contact the OneSignal Support team.

This page was last modified: 03 Jan 2024



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