Skip to main content

Freshdesk

Availability:
Available Airbyte CloudAvailable Airbyte OSSAvailable PyAirbyte
Support Level:
Airbyte Connector
Connector Version:
3.1.1(Last updated 3 months ago)
CDK Version:
0.72.2
Sync Success Rate:
Usage Rate:

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

Prerequisites​

To set up the Freshdesk source connector, you'll need the Freshdesk domain URL and the API key.

Set up the Freshdesk connector in Airbyte​

  1. Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
  2. Click Sources and then click + New source.
  3. On the Set up the source page, select Freshdesk from the Source type dropdown.
  4. Enter the name for the Freshdesk connector.
  5. For Domain, enter your Freshdesk domain URL.
  6. For API Key, enter your Freshdesk API key.
  7. For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
  8. For Requests per minute, enter the number of requests per minute that this source allowed to use. The Freshdesk rate limit is 50 requests per minute per app per account.
  9. For Lookback Window, you may specify a number of days back from the current stream state to re-read data for the Satisfaction Ratings stream. This helps capture updates made to existing ratings after their initial creation. However, keep in mind that records updated before (stream_state - lookback_window) won't be synced. To ensure no data loss, we recommend using a full refresh. The default lookback window is set to 14 days.
  10. Click Set up source.

Supported sync modes​

Supported Streams​

Several output streams are available from this source:

Performance considerations​

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

If you don't use the start date Freshdesk will retrieve only the last 30 days. More information here.

Reference​

Config fields reference

Field
Type
Property name
string
api_key
string
domain
integer
requests_per_minute
string
start_date
integer
lookback_window_in_days

Changelog​

Expand to review
VersionDatePull RequestSubject
3.1.12024-06-0639231[autopull] Upgrade base image to v1.2.2
3.1.02024-03-1235699Migrate to low-code
3.0.72024-02-1235187Manage dependencies with Poetry.
3.0.62024-01-1034101Base image migration: remove Dockerfile and use the python-connector-base image
3.0.52023-11-3033000Base image migration: remove Dockerfile and use the python-connector-base image
3.0.42023-06-2427680Fix formatting
3.0.32023-06-0226978Skip the stream if subscription level had changed during sync
3.0.22023-02-0621970Enable availability strategy for all streams
3.0.02023-01-3122164Rename nested business_hours table to working_hours
2.0.12023-01-2721888Set AvailabilityStrategy for streams explicitly to None
2.0.02022-12-2020416Fix SlaPolicies stream schema
1.0.02022-11-1619496Fix Contacts stream schema
0.3.82022-11-1119349Do not rely on response.json() when deciding to retry a request
0.3.72022-11-0318397Fix base url for v2 API.
0.3.62022-09-2917410Migrate to per-stream states.
0.3.52022-09-2717249Added nullable to all stream schemas, added transformation into declared schema types
0.3.42022-09-2717243Fixed the issue, when selected stream is not available due to Subscription Plan
0.3.32022-08-0615378Allow backward compatibility for input configuration
0.3.22022-06-2314049Update parsing of start_date
0.3.12022-06-0313332Add new streams
0.3.02022-05-3012334Implement with latest CDK
0.2.112021-12-148682Migrate to the CDK
0.2.102021-12-068524Update connector fields title/description
0.2.92021-11-168017Bugfix an issue that caused the connector to not sync more than 50000 contacts
0.2.82021-10-287486Include "requester" and "stats" fields in "tickets" stream
0.2.72021-10-136442Add start_date parameter to specification from which to start pulling data.
Was this page helpful?