The tap-onesignal
extractor
pulls data from
OneSignal that can
then be sent to a destination using a
loader.
Airbyte Usage Notice
Container-based connectors
can introduce deployment challenges including the potential need to run
Docker-in-Docker (not currently supported by services like AWS ECS, Meltano
Cloud, etc. see
FAQ
and
Airbyte's ECS deployment docs
for more details). Before using this variant we recommend considering if/how
you will be able to deploy container-based connectors to production.
For more context on how this Airbyte integration works please checkout out the
FAQ in the Meltano Docs.
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-onesignal extractor to your
project using
:meltano add -
Configure the tap-onesignal
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-onesignalmeltano config tap-onesignal set --interactivemeltano config tap-onesignal testNext steps
Follow the remaining steps of the Getting Started guide:
If you run into any issues, learn how to get help.
Capabilities
The current capabilities for
tap-onesignal
may have been automatically set when originally added to the Hub. Please review the
capabilities when using this extractor. If you find they are out of date, please
consider updating them by making a pull request to the YAML file that defines the
capabilities for this extractor.
This plugin has the following capabilities:
- about
- catalog
- discover
- schema-flattening
- state
- stream-maps
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-onesignal settings that are known to Meltano are documented below. To quickly
find the setting you're looking for, click on any setting name from the list:
airbyte_config.outcome_namesairbyte_config.start_dateairbyte_config.user_auth_keyairbyte_spec.imageairbyte_spec.tagdocker_mounts
Expand To Show SDK Settings
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-onesignal list
You can
override these settings or specify additional ones
in your meltano.yml by adding the settings key.
Please consider adding any settings you have defined locally to this definition on MeltanoHub by making a pull request to the YAML file that defines the settings for this plugin.
Airbyte Config Outcome Names (airbyte_config.outcome_names)
-
Environment variable:
TAP_ONESIGNAL_AIRBYTE_CONFIG_OUTCOME_NAMES
Comma-separated list of names and the value (sum/count) for the returned outcome data. See the docs for more details
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set airbyte_config outcome_names [value]Airbyte Config Start Date (airbyte_config.start_date)
-
Environment variable:
TAP_ONESIGNAL_AIRBYTE_CONFIG_START_DATE
The date from which you'd like to replicate data for OneSignal API, in the format YYYY-MM-DDT00:00:00Z. All data generated after this date will be replicated.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set airbyte_config start_date [value]Airbyte Config User Auth Key (airbyte_config.user_auth_key)
-
Environment variable:
TAP_ONESIGNAL_AIRBYTE_CONFIG_USER_AUTH_KEY
OneSignal User Auth Key, see the docs for more information on how to obtain this key.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set airbyte_config user_auth_key [value]Airbyte Spec Image (airbyte_spec.image)
-
Environment variable:
TAP_ONESIGNAL_AIRBYTE_SPEC_IMAGE -
Default Value:
airbyte/source-onesignal
Airbyte image to run
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set airbyte_spec image [value]Airbyte Spec Tag (airbyte_spec.tag)
-
Environment variable:
TAP_ONESIGNAL_AIRBYTE_SPEC_TAG -
Default Value:
latest
Airbyte image tag
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set airbyte_spec tag [value]Docker Mounts (docker_mounts)
-
Environment variable:
TAP_ONESIGNAL_DOCKER_MOUNTS
Docker mounts to make available to the Airbyte container. Expects a list of maps containing source, target, and type as is documented in the docker --mount documentation
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set docker_mounts [value]Expand To Show SDK Settings
Flattening Enabled (flattening_enabled)
-
Environment variable:
TAP_ONESIGNAL_FLATTENING_ENABLED
'True' to enable schema flattening and automatically expand nested properties.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set flattening_enabled [value]Flattening Max Depth (flattening_max_depth)
-
Environment variable:
TAP_ONESIGNAL_FLATTENING_MAX_DEPTH
The max depth to flatten schemas.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set flattening_max_depth [value]Stream Map Config (stream_map_config)
-
Environment variable:
TAP_ONESIGNAL_STREAM_MAP_CONFIG
User-defined config values to be used within map expressions.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set stream_map_config [value]Stream Maps (stream_maps)
-
Environment variable:
TAP_ONESIGNAL_STREAM_MAPS
Config object for stream maps capability. For more information check out Stream Maps.
Configure this setting directly using the following Meltano command:
meltano config tap-onesignal set stream_maps [value]Something missing?
This page is generated from a YAML file that you can contribute changes to.
Edit it on GitHub!Looking for help?
#plugins-general-yellow){kind=icon}
