Skip to main content

OneSignal

This page contains the setup guide and reference information for the OneSignal source connector.

Prerequisites

Setup guide

Step 1: Set up OneSignal

Step 2: Set up the OneSignal connector in Airbyte

For Airbyte Cloud:

  1. Log into your Airbyte Cloud account.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select OneSignal from the Source type dropdown.
  4. Enter a name for the OneSignal connector.
  5. Enter User Auth Key
  6. Enter Applications credentials (repeat for every application):
    1. Enter App Name (for internal purposes only)
    2. Enter App ID
    3. Enter REST API Key
  7. Enter the Start Date in format YYYY-MM-DDTHH:mm:ssZ
  8. Enter Outcome names as comma separated values, e.g. os__session_duration.count,os__click.count, see the API docs for more details.

For Airbyte Open Source:

  1. Navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select OneSignal from the Source type dropdown.
  4. Enter the name for the OneSignal connector.
  5. Enter User Auth Key
  6. Enter Applications credentials (repeat for every application):
    1. Enter App Name (for internal purposes only)
    2. Enter App ID
    3. Enter REST API Key
  7. Enter the Start Date in format YYYY-MM-DDTHH:mm:ssZ
  8. Enter Outcome names as comma separated values, e.g. os__session_duration.count,os__click.count, see the API docs for more details.

Supported sync modes

The OneSignal source connector supports the following sync modes:

Supported Streams

Performance considerations

The connector is restricted by normal OneSignal rate limits.

Data type mapping

Integration TypeAirbyte TypeNotes
stringstring
integerinteger
numbernumber
arrayarray
objectobject

Reference

Config fields reference

Field
Type
Property name
string
user_auth_key
array<object>
applications
string
start_date
string
outcome_names

Changelog

VersionDatePull RequestSubject
1.1.02023-08-3128941Migrate connector to low-code
1.0.12023-03-1424076Fix schema and add additionalProperties true
1.0.02023-03-1424076Update connectors spec; fix incremental sync
0.1.22021-12-078582Update connector fields title/description
0.1.12021-11-107617Fix get_update state
0.1.02021-10-136998Initial Release