Freshdesk
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
- Log into your Airbyte Cloud account or navigate to the Airbyte Open Source dashboard.
- Click Sources and then click + New source.
- On the Set up the source page, select Freshdesk from the Source type dropdown.
- Enter the name for the Freshdesk connector.
- For Domain, enter your Freshdesk domain URL.
- For API Key, enter your Freshdesk API key.
- For Start Date, enter the date in YYYY-MM-DDTHH:mm:ssZ format. The data added on and after this date will be replicated.
- 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.
- Click Set up source.
Supported sync modes
Supported Streams
Several output streams are available from this source:
- Agents
- Business Hours
- Canned Responses
- Canned Response Folders
- Companies
- Contacts (Native Incremental Sync)
- Conversations
- Discussion Categories
- Discussion Comments
- Discussion Forums
- Discussion Topics
- Email Configs
- Email Mailboxes
- Groups
- Products
- Roles
- Satisfaction Ratings
- Scenario Automations
- Settings
- Skills
- SLA Policies
- Solution Articles
- Solution Categories
- Solution Folders
- Surveys
- Tickets (Native Incremental Sync)
- Ticket Fields
- Time Entries
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
domain
string
api_key
integer
requests_per_minute
string
start_date
Changelog
| Version | Date | Pull Request | Subject |
|---|---|---|---|
| 3.0.7 | 2024-02-12 | 35187 | Manage dependencies with Poetry. |
| 3.0.6 | 2024-01-10 | 34101 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 3.0.5 | 2023-11-30 | 33000 | Base image migration: remove Dockerfile and use the python-connector-base image |
| 3.0.4 | 2023-06-24 | 27680 | Fix formatting |
| 3.0.3 | 2023-06-02 | 26978 | Skip the stream if subscription level had changed during sync |
| 3.0.2 | 2023-02-06 | 21970 | Enable availability strategy for all streams |
| 3.0.0 | 2023-01-31 | 22164 | Rename nested business_hours table to working_hours |
| 2.0.1 | 2023-01-27 | 21888 | Set AvailabilityStrategy for streams explicitly to None |
| 2.0.0 | 2022-12-20 | 20416 | Fix SlaPolicies stream schema |
| 1.0.0 | 2022-11-16 | 19496 | Fix Contacts stream schema |
| 0.3.8 | 2022-11-11 | 19349 | Do not rely on response.json() when deciding to retry a request |
| 0.3.7 | 2022-11-03 | 18397 | Fix base url for v2 API. |
| 0.3.6 | 2022-09-29 | 17410 | Migrate to per-stream states. |
| 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 compatibility 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 to not 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. |