The tap-outreach extractor pulls data from Outreach that can then be sent to a destination using a loader.
Alternate Implementations
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-outreach extractor to your
project using
:meltano add -
Configure the tap-outreach
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-outreachmeltano config tap-outreach set --interactivemeltano config tap-outreach 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-outreach
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:
- catalog
- discover
- state
You can
override these capabilities or specify additional ones
in your meltano.yml by adding the capabilities key.
Settings
The
tap-outreach 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:
You can also list these settings using
with the meltano configlist
subcommand:
meltano config tap-outreach 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.
Client ID (client_id)
-
Environment variable:
TAP_OUTREACH_CLIENT_ID
Your Outreach client ID.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_OUTREACH_CLIENT_SECRET
Your Outreach client secret.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set client_secret [value]Page Size (page_size)
-
Environment variable:
TAP_OUTREACH_PAGE_SIZE
The page size of request responses.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set page_size [value]Quota Limit (quota_limit)
-
Environment variable:
TAP_OUTREACH_QUOTA_LIMIT
The request quota limit.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set quota_limit [value]Redirect URI (redirect_uri)
-
Environment variable:
TAP_OUTREACH_REDIRECT_URI
The Outreach redirect URI.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set redirect_uri [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_OUTREACH_REFRESH_TOKEN
Your Outreach refresh token.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_OUTREACH_START_DATE
Determines how much historical data will be extracted. Please be aware that the larger the time period and amount of data, the longer the initial extraction can be expected to take.
Configure this setting directly using the following Meltano command:
meltano config tap-outreach set start_date [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
