Linking OneSignal as a source

Alpha release

This source is currently in alpha. The interface and available tables may change.

Let AI connect your sources for you

Skip the manual setup — run this in your project and the wizard auto-detects your databases and APIs and connects them to PostHog.

Learn more
PostHog Wizard hedgehog

The OneSignal connector pulls your push notification, email, and SMS message data along with audience segments into the PostHog data warehouse.

Note: OneSignal retains API messages for 30 days, so the first sync backfills at most the last 30 days of message history.

Prerequisites

You need a OneSignal account with access to an app's Settings > Keys & IDs page, where you can find the App ID and App API key.

Adding a data source

  1. In PostHog, go to the Sources tab of the data pipeline section.
  2. Click + New source and click Link next to this source.
  3. Enter your credentials (see Configuration below) and click Next.
  4. Select the tables you want to sync, choose a sync method and frequency, then click Import.

Once the syncs are complete, you can start querying this data in PostHog.

This source needs two credentials from your OneSignal app:

  1. App ID – The UUID shown at the top of Settings > Keys & IDs in your OneSignal dashboard.
  2. App API key – The REST API key from the same page. Enter the key value without the Key prefix or any spaces.

Paste both values into the corresponding fields in PostHog and click Next. Select the tables you want to sync, set the sync frequency, then click Import.

Sync modes

Each table can be synced in one of several modes, depending on what the source supports:

  • Webhook (when available) – the source pushes changes to PostHog in real time. Fastest freshness, lowest ongoing cost, and the only mode that reliably captures updates and deletes.
  • Incremental – only new or updated rows are synced on each run, using a cursor field (such as an updated_at timestamp). Cheaper than a full refresh, but deletes aren't captured.
  • Append only – new rows are appended using a cursor field; existing rows are never updated. Ideal for immutable, append-only tables like event logs.
  • Full refresh – the whole table is reloaded on every sync. Use it when a table has no reliable cursor or when you need deletions reflected.

See sync methods for a full explanation of how each mode works and how to choose between them.

Both tables use full refresh on every sync:

  • notifications – Delivery and engagement totals change over time, so a full refresh captures the latest counts.
  • segments – The OneSignal segments API has no timestamp filter, so a full refresh is the only option.

Configuration

OptionTypeRequired
App IDtextYes
App API keypasswordYes

Supported tables

TableDescriptionSync methodIncremental fieldPrimary key
notifications

Push, email, and SMS messages with delivery and engagement totals. API messages have 30-day retention. Journey messages are excluded.

Full refresh—id
segments

Audience segment metadata, including names, creation times, and status. Excludes filters and audience members.

Full refresh—id

TableDescriptionSync method
notificationsPush, email, and SMS messages with delivery and engagement totals. Journey messages are excluded.Full refresh
segmentsAudience segment metadata, including names, creation times, and status. Excludes filters and audience members.Full refresh

Troubleshooting

The source fails with a 401 error

OneSignal rejected the App API key. The key may be invalid, expired, or belong to a different app. Generate a new key in Settings > Keys & IDs and reconnect the source.

The source fails with a 403 error

The App API key doesn't have permission to read the requested data. Check that the key has the correct permissions and isn't restricted by IP address in your OneSignal app settings.

The source fails with a 400 error

OneSignal rejected the request, which usually means the App ID is wrong or doesn't match the App API key. Verify both values in Settings > Keys & IDs and update them in PostHog.

If your sync is failing or data looks wrong, see the Data warehouse troubleshooting guide. If that doesn't help, contact support – we're happy to help.

Still have questions?

Was this page useful?