Skip to main content

OneSignal

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Marketplace
Connector Version
1.2.53 (last updated a month ago)
Sync Success Rate
Usage Rate
Definition ID
bb6afd81-87d5-47e3-97c4-e2c2901b1cf8

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

IP allow list​

If you use Airbyte Cloud and your organization restricts access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Reference​

Config fields reference

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

Changelog​

Expand to review
VersionDatePull RequestSubject
1.2.532026-04-2877334Update dependencies
1.2.522026-04-2176716Update dependencies
1.2.512026-03-3175648Update dependencies
1.2.502026-03-2474991Update dependencies
1.2.492026-03-1074661Update dependencies
1.2.482026-02-2473815Update dependencies
1.2.472026-02-1073116Update dependencies
1.2.462026-02-0372556Update dependencies
1.2.452026-01-2071929Update dependencies
1.2.442026-01-1471592Update dependencies
1.2.432025-12-1870573Update dependencies
1.2.422025-11-2569879Update dependencies
1.2.412025-11-1869398Update dependencies
1.2.402025-10-2968699Update dependencies
1.2.392025-10-2168357Update dependencies
1.2.382025-10-1467769Update dependencies
1.2.372025-10-0767418Update dependencies
1.2.362025-09-3066933Update dependencies
1.2.352025-09-2466618Update dependencies
1.2.342025-09-0965751Update dependencies
1.2.332025-08-2365224Update dependencies
1.2.322025-08-0964719Update dependencies
1.2.312025-08-0264257Update dependencies
1.2.302025-07-2663870Update dependencies
1.2.292025-07-1963415Update dependencies
1.2.282025-07-1263263Update dependencies
1.2.272025-07-0562555Update dependencies
1.2.262025-06-2862359Update dependencies
1.2.252025-06-2161877Update dependencies
1.2.242025-06-1461032Update dependencies
1.2.232025-05-2460514Update dependencies
1.2.222025-05-1060092Update dependencies
1.2.212025-05-0459504Update dependencies
1.2.202025-04-2759054Update dependencies
1.2.192025-04-1958518Update dependencies
1.2.182025-04-1257904Update dependencies
1.2.172025-04-0556773Update dependencies
1.2.162025-03-2256237Update dependencies
1.2.152025-03-0855545Update dependencies
1.2.142025-03-0155040Update dependencies
1.2.132025-02-2354587Update dependencies
1.2.122025-02-1553964Update dependencies
1.2.112025-02-0853461Update dependencies
1.2.102025-02-0153007Update dependencies
1.2.92025-01-2552539Update dependencies
1.2.82025-01-1851868Update dependencies
1.2.72025-01-1151321Update dependencies
1.2.62024-12-2850719Update dependencies
1.2.52024-12-2150243Update dependencies
1.2.42024-12-1449706Update dependencies
1.2.32024-12-1249349Update dependencies
1.2.22024-12-1149106Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
1.2.12024-10-2947667Update dependencies
1.2.02024-10-0546372Converting to manifest-only format
1.1.142024-09-2846184Update dependencies
1.1.132024-09-2145788Update dependencies
1.1.122024-09-1445528Update dependencies
1.1.112024-09-0745228Update dependencies
1.1.102024-08-3145046Update dependencies
1.1.92024-08-2444673Update dependencies
1.1.82024-08-1744333Update dependencies
1.1.72024-08-1243767Update dependencies
1.1.62024-08-1043468Update dependencies
1.1.52024-08-0342742Update dependencies
1.1.42024-07-2042293Update dependencies
1.1.32024-07-1341785Update dependencies
1.1.22024-07-1041317Update dependencies
1.1.12024-07-0941033Migrate to poetry base
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
Was this page helpful?