|
| 1 | +--- |
| 2 | +title: OneSignal Source |
| 3 | +id: o9OyD6xsVJ |
| 4 | +beta: true |
| 5 | +--- |
| 6 | + |
| 7 | +[OneSignal](https://onesignal.com){:target="_blank"} 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. |
| 8 | + |
| 9 | +OneSignal maintains this source. For any issues with the source, [contact the OneSignal Support team ](mailto:[email protected]) |
| 10 | + |
| 11 | + |
| 12 | +## Getting started |
| 13 | + |
| 14 | +1. From your workspace’s [Sources catalog page](https://app.segment.com/goto-my-workspace/sources/catalog){:target="_blank"}, search for **OneSignal** and then click on the OneSignal Source Tile. |
| 15 | +2. On the OneSignal Source Catalog page, click **Add Source**. |
| 16 | +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. |
| 17 | +4. Copy the [write key](/docs/connections/find-writekey) from your Segment workspace. |
| 18 | +5. Log in to the OneSignal Dashboard. |
| 19 | +6. Navigate to enable the integration: **Settings > Integrations > Segment.com** and click **Activate**. |
| 20 | +7. Scroll down to the **Data Out** panel and enter your write key from your Segment workspace. |
| 21 | +9. Select the OneSignal Events you want to export, then click **Save**. |
| 22 | + |
| 23 | + |
| 24 | +> info "" |
| 25 | +> 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. |
| 26 | +
|
| 27 | +You are now all set to sync events from OneSignal to your Segment workspace. |
| 28 | + |
| 29 | +## Stream |
| 30 | + |
| 31 | +OneSignal uses Segment’s [stream source component](/docs/partners/streams/) to send events to Segment. These events are then available in any destination that accepts server-side events, including your data warehouse. |
| 32 | + |
| 33 | +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. |
| 34 | + |
| 35 | +Events with no External ID present are anonymous events. |
| 36 | + |
| 37 | +## Identifiers |
| 38 | + |
| 39 | +The events OneSignal sends to Segment are identifiers with either `userId` or `anonymousId`. |
| 40 | + |
| 41 | +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. |
| 42 | + |
| 43 | +OneSignal doesn't send user email address or phone number details to Segment. |
| 44 | + |
| 45 | + |
| 46 | +## Events |
| 47 | + |
| 48 | +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. |
| 49 | + |
| 50 | +| Event Kind | Event Description | |
| 51 | +| ----------------------------- | ---------------------------------------------------- | |
| 52 | +| Push Sent | Push notification successfully sent | |
| 53 | +| Push Received | Push notification successfully received | |
| 54 | +| Push Clicked | Push notification touched on device | |
| 55 | +| In-App Message Displayed | In-App Message successfully displayed on device | |
| 56 | +| In-App Message Clicked | In-App Message clicked on device | |
| 57 | +| In-App Message Page Displayed | In-App Message page is displayed | |
| 58 | +| Email Sent | Email successfully sent | |
| 59 | +| Email Opened | Email opened by recipient | |
| 60 | +| Email Unsubscribed | Email unsubscribed by recipient | |
| 61 | +| Email Received | Email received by recipient | |
| 62 | +| Email Reported As Spam | Email reported as spam by recipient | |
| 63 | +| Email Hardbounced | Email returned to sender due to permanent error | |
| 64 | +| Email Failed | Could not deliver the email to the recipient's inbox | |
| 65 | +| SMS Sent | SMS sent to recipient | |
| 66 | +| SMS Delivered | SMS successfully delivered | |
| 67 | +| SMS Failed | SMS failed to send | |
| 68 | + |
| 69 | +## Event properties |
| 70 | + |
| 71 | +The following table lists the properties included in the events from the Events table. |
| 72 | + |
| 73 | +| Property Name | Description | |
| 74 | +| ------------------- | -------------------------------------------------- | |
| 75 | +| `messageId` | The identifier of the discrete message | |
| 76 | +| `campaign_id` | The identifier of the message campaign | |
| 77 | +| `message_name` | The message name | |
| 78 | +| `message_title` | The message title | |
| 79 | +| `message_contents` | The message contents | |
| 80 | +| `message_type` | The type of message sent, push, in-app, email, SMS | |
| 81 | +| `subscription_type` | The channel the message was sent through | |
| 82 | +| `template_id` | The message template used | |
| 83 | +| `onesignal_id` | The OneSignal set user identifier | |
| 84 | + |
| 85 | + |
| 86 | + |
| 87 | +## Adding destinations |
| 88 | + |
| 89 | +Now that your source is set up, you can connect it with Destinations. |
| 90 | + |
| 91 | +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. |
| 92 | + |
| 93 | +If there are any issues with how the events are arriving to Segment, [contact the OneSignal Support team ](mailto:[email protected]). |
0 commit comments