Skip to main content

Freshservice

Overview

The Freshservice connector supports both full refresh and incremental syncs. 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.

Output schema

Several output streams are available from this source:

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

Features

FeatureSupported?
Full Refresh SyncYes
Incremental SyncYes
SSL connectionYes
NamespacesNo

Performance considerations

The Freshservice connector should not run into Freshservice API limitations under normal usage. The API implements rate limiting that varies based on the Freshservice plan:

  • Starter: 100 requests/min overall limit
  • Growth: 200 requests/min overall limit
  • Pro: 400 requests/min overall limit
  • Enterprise: 500 requests/min overall limit

There are also sublimits for specific operations (e.g., "View Ticket" which is 50 requests/min for the Starter plan). The connector automatically handles rate limiting with backoff strategies. Please create an issue if you see any rate limit issues that are not automatically retried successfully.

Getting started

Requirements

  • Freshservice Account
  • Freshservice API Key
  • Freshservice domain name (e.g., your-domain.freshservice.com)
  • Replication Start Date (in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ)

Setup guide

Freshservice API Key

  1. Log in to your Freshservice account
  2. Navigate to your profile settings by clicking on your profile picture in the top right corner
  3. Under the API section, you will find your API key
  4. If you don't have an API key, you can generate a new one

For more details, please read How to find your API key.

Domain Name

Your Freshservice domain is the subdomain of your Freshservice account URL. For example, if you access Freshservice at https://your-company.freshservice.com, then your domain name is your-company.freshservice.com.

Reference

This connector uses the Freshservice REST API v2. All API requests must use HTTPS.

Reference

Config fields reference

Field
Type
Property name
string
api_key
string
domain_name
string
start_date

Changelog

Expand to review
VersionDatePull RequestSubject
1.4.252025-05-1059922Update dependencies
1.4.242025-05-0359405Update dependencies
1.4.232025-04-2658877Update dependencies
1.4.222025-04-1958343Update dependencies
1.4.212025-04-1257781Update dependencies
1.4.202025-04-0557197Update dependencies
1.4.192025-03-2956501Update dependencies
1.4.182025-03-2255953Update dependencies
1.4.172025-03-0855272Update dependencies
1.4.162025-03-0154928Update dependencies
1.4.152025-02-2254438Update dependencies
1.4.142025-02-1553758Update dependencies
1.4.132025-02-0853333Update dependencies
1.4.122025-02-0152816Update dependencies
1.4.112025-01-2552313Update dependencies
1.4.102025-01-1851684Update dependencies
1.4.92025-01-1151075Update dependencies
1.4.82024-12-2850574Update dependencies
1.4.72024-12-2150026Update dependencies
1.4.62024-12-1449519Update dependencies
1.4.52024-12-1249187Update dependencies
1.4.42024-12-1148939Starting 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
1.4.32024-10-2947732Update dependencies
1.4.22024-10-2847449Update dependencies
1.4.12024-08-1644196Bump source-declarative-manifest version
1.4.02024-08-1544148Refactor connector to manifest-only format
1.3.172024-08-1043545Update dependencies
1.3.162024-08-0343254Update dependencies
1.3.152024-07-2742663Update dependencies
1.3.142024-07-2042382Update dependencies
1.3.132024-07-1341713Update dependencies
1.3.122024-07-1041423Update dependencies
1.3.112024-07-0941311Update dependencies
1.3.102024-07-0640941Update dependencies
1.3.92024-06-2540381Update dependencies
1.3.82024-06-2240177Update dependencies
1.3.72024-06-0639173[autopull] Upgrade base image to v1.2.2
1.3.62024-05-1538195Make connector compatible with builder
1.3.52024-04-1937162Updating to 0.80.0 CDK
1.3.42024-04-1837162Manage dependencies with Poetry.
1.3.32024-04-1537162Base image migration: remove Dockerfile and use the python-connector-base image
1.3.22024-04-1237162schema descriptions
1.3.12024-01-2934633Add backoff policy for Requested Items stream
1.3.02024-01-1529126Add Requested Items stream
1.2.02023-08-0629126Migrated to Low-Code CDK
1.1.02023-05-0925929Add stream for customer satisfaction survey responses endpoint
1.0.02023-05-0225743Correct data types in tickets, agents and requesters schemas to match Freshservice API
0.1.12021-12-289143Update titles and descriptions
0.1.02021-10-296967🎉 New Source: Freshservice