Freshdesk

tap-freshdesk from singer-io

Customer Support Software

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

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-freshdesk extractor to your project using
    meltano add
    :
  2. meltano add extractor tap-freshdesk
  3. Configure the tap-freshdesk settings using
    meltano config
    :
  4. meltano config tap-freshdesk set --interactive
  5. Test that extractor settings are valid using
    meltano config
    :
  6. meltano config tap-freshdesk test

Next steps

If you run into any issues, learn how to get help.

Capabilities

The current capabilities for tap-freshdesk 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:

  • state

You can override these capabilities or specify additional ones in your meltano.yml by adding the capabilities key.

Settings

The tap-freshdesk 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.

Domain (domain)

  • Environment variable: TAP_FRESHDESK_DOMAIN

Your Freshdesk subdomain.

API Key (api_key)

  • Environment variable: TAP_FRESHDESK_API_KEY

Your Freshdesk API key.

User Agent (user_agent)

  • Environment variable: TAP_FRESHDESK_USER_AGENT

The user agent to send with API requests.

Start Date (start_date)

  • Environment variable: TAP_FRESHDESK_START_DATE

Determines how much historical data will be extracted. Please be aware that the larger the time peri[start_date] required: od and amount of data, the longer the initial extraction can be expected to take.

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

Maintenance Status

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

Maintainer

  • Stitch Data

Meltano Stats

  • Total Executions (Last 3 Months)
  • Projects (Last 3 Months)

PyPI Stats

  • PyPI Downloads
  • PyPI Package Version

Keywords

  • api