The tap-helpscout extractor pulls data from Helpscout that can then be sent to a destination using a loader.
Alternate Implementations
-
Bytecode IO
- Stitch Data (default)🥉
Getting Started
Prerequisites
If you haven't already, follow the initial steps of the Getting Started guide:
Installation and configuration
-
Add the tap-helpscout extractor to your
project using
:meltano add -
Configure the tap-helpscout
settings using
:meltano config -
Test that extractor settings are valid using
:meltano config
meltano add extractor tap-helpscoutmeltano config tap-helpscout set --interactivemeltano config tap-helpscout 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-helpscout
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-helpscout 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-helpscout 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_HELPSCOUT_CLIENT_ID
Your Help Scout client ID. Follow these instructions to Create My App in your User Profile of the HelpScout web console application.
Configure this setting directly using the following Meltano command:
meltano config tap-helpscout set client_id [value]Client Secret (client_secret)
-
Environment variable:
TAP_HELPSCOUT_CLIENT_SECRET
Your Help Scout client secret. Follow these instructions to Create My App in your User Profile of the HelpScout web console application.
Configure this setting directly using the following Meltano command:
meltano config tap-helpscout set client_secret [value]Refresh Token (refresh_token)
-
Environment variable:
TAP_HELPSCOUT_REFRESH_TOKEN
Your Help Scout refresh token. See the refresh token docs for more details.
Configure this setting directly using the following Meltano command:
meltano config tap-helpscout set refresh_token [value]Start Date (start_date)
-
Environment variable:
TAP_HELPSCOUT_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-helpscout set start_date [value]User Agent (user_agent)
-
Environment variable:
TAP_HELPSCOUT_USER_AGENT
The user agent to send with requests.
Configure this setting directly using the following Meltano command:
meltano config tap-helpscout set user_agent [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-brightgreen){kind=icon}
