Skip to main content

Freshdesk

Availability
Available CoreAvailable StandardAvailable PlusAvailable ProAvailable Enterprise FlexAvailable Self-Managed EnterpriseAvailable PyAirbyte
Support Level
Airbyte
Connector Version
3.2.16 (last updated 13 days ago)
Definition ID
ec4b9503-13cb-48ab-a4ab-6ade4be46567

This page contains the setup guide and reference information for the Freshdesk source connector.

Prerequisites​

  • A Freshdesk account with an API key. The API key belongs to the agent whose credentials are used, and that agent must have access to the resources you want to sync.
  • Your Freshdesk domain in the format yourcompany.freshdesk.com.

Set up the Freshdesk connector in Airbyte​

  1. Log into your Airbyte Cloud account, or navigate to your 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 a name for the Freshdesk connector.
  5. For Domain, enter your Freshdesk domain, for example mycompany.freshdesk.com.
  6. For API Key, enter your Freshdesk API key.
  7. For Start Date, optionally enter a date in YYYY-MM-DDTHH:mm:ssZ format. Only data created or updated on or after this date will be replicated for incremental streams. If not set, the connector syncs all available data.
  8. For Requests per minute, optionally enter a custom rate limit. If left empty, the connector uses the default for your plan. See Performance considerations for details.
  9. For Rate Limit Plan, select your Freshdesk subscription plan. This tells the connector the per-endpoint rate limits for the Tickets and Contacts APIs, which differ from the general rate limit. If you are unsure, select Free Plan for the most conservative limits.
  10. 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. Records updated before the lookback window boundary are not re-synced. The default is 14 days.
  11. For Number of Concurrent Threads, optionally adjust the number of parallel sync threads. Higher values speed up syncs but consume more of your API rate limit. The default is 5.
  12. Click Set up source.

Supported sync modes​

Supported Streams​

Several output streams are available from this source:

Performance considerations​

Freshdesk enforces API rate limits that vary by plan:

PlanGeneral rate limitTickets list limitContacts list limit
Free50/min50/min50/min
Growth200/min20/min20/min
Pro400/min100/min100/min
Enterprise700/min200/min200/min

The connector respects the Retry-After header and automatically retries when rate-limited. To minimize rate limit errors, select the correct Rate Limit Plan in the connector configuration so the connector can budget API calls appropriately.

If you increase Number of Concurrent Threads, monitor your rate limit usage. Higher concurrency speeds up syncs but increases the chance of hitting per-minute limits, especially on Free and Growth plans.

Reference​

Config fields reference

Field
Type
Property name
string
api_key
string
domain
integer
lookback_window_in_days
integer
num_workers
object
rate_limit_plan
integer
requests_per_minute
string
start_date
string
subscription_tier

Changelog​

Expand to review
VersionDatePull RequestSubject
3.2.162026-04-24Add subscription_tier spec field with dynamic plan-based rate limiting
3.2.152026-04-2476979Update source-declarative-manifest base image to 7.17.4
3.2.142026-04-2376957Promoted release candidate to GA
3.2.14-rc.52026-04-22Re-enable HTTPAPIBudget, keep c=5 for Full Tier 2 rollout
3.2.14-rc.42026-04-17Revert default_concurrency from 6 to 5 and disable HTTPAPIBudget for tuning experiment
3.2.14-rc.32026-04-14Concurrency tuning iteration 3: increase default_concurrency from 5 to 6
3.2.14-rc.22026-04-1376272Concurrency tuning iteration 2: increase default_concurrency from 4 to 5
3.2.14-rc.12026-04-1076202Add concurrency_level and num_workers for concurrency tuning
3.2.132026-03-3175719Update dependencies
3.2.122026-03-2474647Update dependencies
3.2.112026-03-0374188Update dependencies
3.2.102026-02-1773400Update dependencies
3.2.92026-02-1072557Update dependencies
3.2.82026-01-2071949Update dependencies
3.2.72026-01-1471629Update dependencies
3.2.62025-12-1870595Update dependencies
3.2.52025-11-2570016Update dependencies
3.2.42025-11-1869435Update dependencies
3.2.32025-10-2968786Update dependencies
3.2.22025-10-2268591Add suggestedStreams
3.2.12025-10-2168420Update dependencies
3.2.02025-10-1468089Complete progressive rollout
3.2.0-rc.22025-10-0967109Migrate to CDK v7
3.2.0-rc.12025-03-1254687Migrate to Manifest-only
3.1.32025-02-2654696Update requests-mock dependency versionb
3.1.22025-01-1143887Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
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?