Skip to main content

OneSignal

Overview​

This page documents the OneSignal connector.

  • Source: Available for credential validation, but extraction is still in development.
  • Destination (OneSignal Audiences): Present for credential validation, but loading is still in development.

Prerequisites​

You’ll need:

  • A OneSignal App ID
  • A OneSignal REST API Key (used as a Basic auth token)

Authentication​

The connector authenticates to OneSignal using:

  • app_id (your OneSignal App ID)
  • rest_api_key (your OneSignal REST API Key)

Credential validation calls:

  • GET https://api.onesignal.com/apps/{app_id}
  • Header: Authorization: Basic {rest_api_key}

Setup​

  1. In OneSignal, locate your App ID for the app you want to connect.
  2. Generate or copy your REST API Key.
  3. In your workspace, create a new OneSignal connection and enter the configuration fields below.
  4. Run a test/login to validate credentials.

Configuration reference​

FieldTypeRequiredDescription
app_idstring✅OneSignal App ID.
rest_api_keystring✅OneSignal REST API Key used for Authorization: Basic ....

Streams (Source)​

No streams are currently exposed. The source catalog is empty and extraction is still in development.

OneSignal Audiences (Destination)​

The OneSignal Audiences destination currently supports credential validation only. Loading/syncing records is still in development and will fail if you attempt to run a load.