Helpscout

tap-helpscout from singer-io

Customer Service Software

The tap-helpscout extractor pulls data from Helpscout that can then be sent to a destination using a loader.

Available Variants

Getting Started

Prerequisites

If you haven't already, follow the initial steps of the Getting Started guide:

  1. Install Meltano
  2. Create your Meltano project

Installation and configuration

  1. Add the tap-helpscout extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-helpscout
  3. Configure the tap-helpscout settings using
    meltano config
    :
  4. meltano config tap-helpscout set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-helpscout test

Next steps

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 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.

User Agent (user_agent)

  • Environment variable: TAP_HELPSCOUT_USER_AGENT

The user agent to send with requests.

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.

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.

Refresh Token (refresh_token)

  • Environment variable: TAP_HELPSCOUT_REFRESH_TOKEN

Your Help Scout refresh token. See the refresh token docs for more details.

Something missing?

This page is generated from a YAML file that you can contribute changes to.

Edit it on GitHub!

Looking for help?

If you're having trouble getting the tap-helpscout extractor to work, look for an existing issue in its repository, file a new issue, or join the Meltano Slack community and ask for help in the
#plugins-general
channel.

Install

meltano add extractor tap-helpscout

Maintenance Status

  • Maintenance Status
  • Stars
  • Forks
  • Open Issues
  • Open PRs
  • Contributors
  • License

Maintainer

  • Stitch Data

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api