---

Overview

The OneSignal + Databricks integration allows you to automatically export message event data from OneSignal to your Databricks lakehouse. This eliminates the need for manual data extraction and gives your team direct access to near real-time engagement data for advanced analysis, dashboarding, and reporting.

You’ll gain visibility into events across email, push notifications, in-app messages, and SMS, and can build custom analytics to inform marketing strategies and cross-functional insights.

Currently, we support message send and engagement events (e.g., clicks, opens). Future updates will expand event coverage to offer a more complete view of your users' journeys.

---

Requirements

OneSignal

• Annual Plan is required to access this integration.

Databricks

• Platform: AWS, Azure, or GCP
• Plan: Premium or higher
• Unity Catalog Enabled:
  • Required for permission management and schema creation.
  • Legacy deployments without Unity Catalog are not supported.
• SQL Warehouse:
  • Used for ingesting and querying exported event data.

---

Setup

1. Configure Databricks

Collect SQL Warehouse Info

1. Navigate to SQL Warehouses in your Databrick workspace.
2. Select your warehouse and click the Connection details tab.
3. Save the following values, you will need them shortly:
   1. Server Hostname
   2. Port
   3. HTTP Path

Create a Service Principal

1. In Workspace Settings, go to Identity and Access > Service Principals.
2. Click Add Service Principal, then Add New.
3. Give it a recognizable name (e.g., onesignal-sync).

Generate a Secret for your Service Principal

1. Click into the created Service Principal.
2. Go to the Secrets tab.
3. Click Generate Secret and save the resulting token.

📘

One time access!

⚠️ You won’t be able to view this secret again, so store it securely.

Add Permissions to your Service Principal

1. Navigate to your Databricks Catalog.
2. Open the Permissions tab.
3. Click Grant, then:
   1. Select your Service Principal.
   2. Grant the following permissions:
      • USE CATALOG
      • USE SCHEMA
      • SELECT
      • MODIFY
      • CREATE SCHEMA
      • CREATE TABLE
        
        

---

2. Connect OneSignal to Databricks

1. In OneSignal, navigate to Data > Integrations > Databricks.
2. Paste the following from your Databricks workspace:
   • Server Hostname
   • Port
   • HTTP Path
   • Catalog Name
   • Schema Name
   • Service Principal credentials (ID + Secret)

3. OneSignal Settings

   1. Set up Sync Frequency, the most frequent setting is 15 minutes
   2. Dataset and Destination Table names will be pre set
      1. Dataset is named as onesignal_events_your-appid
      2. Destination Table is names as message_events
      3. you can update these names if you need to
   3. Select the events you care to receive in your BigQuery dataset. Feel free to select them all.
   
   

4. Click “Save” and wait for the success confirmation

---

3. Send a message to generate events

Once connected, send messages using OneSignal via any channel you use (push, email, in-app, SMS). Message Events will begin syncing into Databricks based on your integration settings.

---

4. View data in Databricks

1. In Databricks, go to your Catalog.
2. After syncing has succeeded, a new Schema (with the name provided during setup) will appear.
3. Inside, you'll find tables containing exported event data.

4. Click into a table to preview Sample Data.

---

📘

Need help?

If you run into any issues—such as:

• Schema not appearing in Catalog
• Permission errors on table creation
• Unexpected event formats or data not syncing

Please reach out to [email protected].

---

Events and Properties

Below is an overview of the data available for the Databricks Data Export Integration. We will offer Message Event data in the beta, and will plan to offer more categories of event data and summary reports in the future.

For this integration, any event data generated by a user for the given OneSignal application will be exported to a customer's Databricks project. Customers will not be able to select specific event kinds or filter the events they receive.

Message Event Kinds

Type: String

The type of message and event (e.g. message.push.received, message.push.sent).

Message Events Properties (columns)

For each message event generated by a user, the following metadata will be attached to the record.

Notes

• Syncs after saving/activating may take an additional 15-30 minutes to complete
• Deactivating may still result in one final sync after deactivation.
• To ensure efficient data synchronization in your BigQuery destination, our system automatically creates and manages staging datasets. These datasets, named with a pattern like fivetran_{two random words}_staging, temporarily store data during processing before it's integrated into your main schema. These staging datasets are essential for maintaining a streamlined workflow and should not be deleted, as they will be automatically recreated.

---

FAQ

Why do I see the same message title and/or message contents but different message ID?

This likely means you sent the same message more than once. Probably related to a transactional message or a template that was sent to different users at different times and/or via different requests.