Skip to content

Latest commit

 

History

History
95 lines (68 loc) · 5.62 KB

freshdesk.md

File metadata and controls

95 lines (68 loc) · 5.62 KB
Raw

Freshdesk

This page guides you through the process of setting up the Freshdesk source connector.

Prerequisites

  • Freshdesk Account
  • Domain URL
  • Freshdesk API Key

Step 1: Set up Freshdesk

Get Domain URL

You can find your domain URL by loggin into your account and check the URL in your browser, the domain url should look like: https://myaccount.freshdesk.com/..., where myaccount.freshdesk.com - is your domain URL.

Get Freshdesk API Key

Follow the link to read more about how to find your API key. You need the admin permissions to access the account settings.

Step 2: Set up the Freshdesk connector in Airbyte

For Airbyte Cloud

  1. Log into your Airbyte Cloud account.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Freshdesk from the Source type dropdown and enter a name for this connector.
  4. Enter your Domain URL.
  5. Enter your Freshdesk API Key.
  6. Choose the Start Date as the starting point for your data replication.
  7. Click Set up source.

For Airbyte Open Source:

  1. Go to local Airbyte page.
  2. In the left navigation bar, click Sources. In the top-right corner, click + new source.
  3. On the source setup page, select Freshdesk from the Source type dropdown and enter a name for this connector.
  4. Enter your Domain URL.
  5. Enter your Freshdesk API Key.
  6. Choose the Start Date as the starting point for your data replication.
  7. Click Set up source.

Supported sync modes & Features

Feature Supported?
Full Refresh Sync Yes
Incremental Sync Yes
SSL connection Yes
Namespaces No

The Freshdesk supports full refresh and incremental sync. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run. There are two types of incremental sync:

  • server level (native) - when API supports filter on specific columns that Airbyte use to track changes (updated_at, created_at, etc)
  • client level - when API doesn't support filter and Airbyte performs filtration on its side.

Supported Streams

Several output streams are available from this source:

If there are more endpoints you'd like Airbyte to support, please create an issue.

Performance considerations

The Freshdesk connector should not run into Freshdesk API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Changelog

Version Date Pull Request Subject
0.3.5 2022-09-27 17249 Added nullable to all stream schemas, added transformation into declared schema types
0.3.4 2022-09-27 17243 Fixed the issue, when selected stream is not available due to Subscription Plan
0.3.3 2022-08-06 15378 Allow backward campatibility for input configuration
0.3.2 2022-06-23 14049 Update parsing of start_date
0.3.1 2022-06-03 13332 Add new streams
0.3.0 2022-05-30 12334 Implement with latest CDK
0.2.11 2021-12-14 8682 Migrate to the CDK
0.2.10 2021-12-06 8524 Update connector fields title/description
0.2.9 2021-11-16 8017 Bugfix an issue that caused the connector not to sync more than 50000 contacts
0.2.8 2021-10-28 7486 Include "requester" and "stats" fields in "tickets" stream
0.2.7 2021-10-13 6442 Add start_date parameter to specification from which to start pulling data.