📘

This Integration is in Private Beta

If you are interested in participating in this beta, please contact your OneSignal Account Representative.

Overview

We understand that gaining deeper insights into engagement is essential for our customers to drive successful messaging strategies. By integrating with OneSignal’s Databricks Data Export functionality, you can automatically sync your messaging event data directly to your Databricks project—eliminating the need for manual exports and giving you immediate access to a centralized data source for advanced analysis

This integration empowers you to perform in-depth analyses of your engagement data across key channels, including email, push notifications, in-app messages, and SMS. You can leverage this data to build custom dashboards, uncover trends, and generate actionable reports for leadership and cross-functional teams.

Currently, the integration supports data exports for events tied to sent messages and related engagement actions (such as clicks, opens, and more). We are continuously expanding our export capabilities and plan to offer additional event types in the near future to provide an even more comprehensive view of your users' journeys.

---

Requirements

Your Databricks account can be set up on Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP).

Databicks Account

• Needs to be on a Premium plan or above Premium plan or above
• Unity Catalog enabled on your Databricks Workspace
  • Unity Catalog is a unified governance solution for all data and AI assets including files, tables, machine learning models and dashboards in your lakehouse on any cloud. Legacy deployments can continue to use Databricks without Unity Catalog
• SQL warehouses
  • SQL warehouses are optimized for data ingestion and analytics workloads, start and shut down rapidly, and are automatically upgraded with Databricks' latest enhancements.

OneSignal Account & Annual Plan

• This integration is only accessible to OneSignal customers on an annual plan.

---

Setup

Step 1- Configure Databricks

1. Gather information from your SQL Warehouse

   1. Navigate to SQL Warehouses, select your warehouse, and switch to the Connection Details tab
   2. Make note of the Server Hostname, Port, and HTTP Path
   

2. Create a Service Principal

   1. Navigate to the workspace Settings
   2. Go to Identity and Access, then Service Principals'
   3. Click “Add Service Principal”, then “Add New”
   

3. Generate a Secret for your Service Principal

   1. Click your service principal
   2. Go to the “Secrets” tab
   3. Generate a secret
   

4. Add Permissions to your Service Principal

   1. Navigate to your Catalog, and go to the Permissions tab
   2. Click the “Grant” button, and enter the name of the service principal you’ve created
   3. Add the following permissions:
      CREATE SCHEMA, CREATE TABLE, SELECT, MODIFY, CREATE SCHEMA, CREATE TABLE
   

Step 2 - Set up Databricks Integration in OneSignal

1. Navigate to the Databricks integrations page in OneSignal
   1. Dashboard > Integrations > Databricks
2. Copy the configuration details that you gathered from your Cluster and your SQL Warehouse in your Databricks account and paste them into the relevant fields in OneSignal

Step 3 - Send a Message

The hard part is over.

Now, we move on to the fun part: generating Message Events. You can send messages to any number of subscriptions using the channel of your choice (as long as you’ve subscribed to receive those events in your integration settings on OneSignal).

Step 4 - Find Message Event Data In Databricks

1. Navigate to your catalog
2. Once syncing has succeeded, you should see a new Schema appear within your Catalog, with the name you gave it when setting up the integration in OneSignal

3. You should be able to click the table and view Sample Data:

If your Databricks set up is not covered by this documentation or if you run into issues with connecting your Onesignal to Databricks, 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

See Event Streams for more details.

The events that be:

• sent - The push, email, or sms was sent to the Subscription
• received - The push or email was received by the Subscription. See Confirmed Delivery.
• clicked - The in-app, push, or email link was clicked by the user.
• failed - The push, email, or sms failed to send. See message results for details.
• unsubscribed - The push, email, or sms Subscription became unsubscribed.
• opened - The email was opened. See Email Message Reports for details.
• spam - The user reported email as spam. See Email deliverability for details.
• bounce - The email address bounced. See Email Message Reports for details.
• suppressed - The email was not sent because the email address is on the Suppression list .
• page_displayed - A card on the in-app carousel displayed to the user.
• impression - The in-app displayed to the user.

Message Events Properties

See Event Streams for more details.

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