Freshsales
This page contains the setup guide and reference information for the Freshsales source connector.
Prerequisites
- Freshsales Account
- Freshsales API Key
- Freshsales Domain Name
Please read How to find your API key.
Setup guide
Step 1: Set up the Freshsales connector in Airbyte
For Airbyte Cloud:
- Log into your Airbyte Cloud account.
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- Set the name for your source
- Enter your
Domain Name
- Enter your
API Key
obtained from these steps - Click Set up source
For Airbyte OSS:
- Navigate to the Airbyte Open Source dashboard
- In the left navigation bar, click Sources. In the top-right corner, click +new source.
- Set the name for your source
- Enter your
Domain Name
- Enter your
API Key
obtained from these steps - Click Set up source
Supported sync modes
Feature | Supported? |
---|---|
Full Refresh Sync | Yes |
Incremental Sync | No |
SSL connection | No |
Namespaces | No |
Supported Streams
Several output streams are available from this source:
- Contacts
- Accounts
- Open Deals
- Won Deals
- Lost Deals
- Open Tasks
- Completed Tasks
- Past appointments
- Upcoming appointments
If there are more endpoints you'd like Airbyte to support, please create an issue.
Performance considerations
The Freshsales connector should not run into Freshsales API limitations under normal usage. Please create an issue if you see any rate limit issues that are not automatically retried successfully.
Reference
Config fields reference
Field
Type
Property name
string
api_key
string
domain_name
Changelog
Expand to review
Version | Date | Pull Request | Subject |
---|---|---|---|
1.0.3 | 2024-06-04 | 39065 | [autopull] Upgrade base image to v1.2.1 |
1.0.2 | 2024-05-21 | 38548 | Upgrade to CDK 1.0.0 |
1.0.1 | 2024-05-28 | 38153 | Make connector compatible with builder |
1.0.0 | 2023-10-21 | 31685 | Migrate to Low-Code CDK |
0.1.4 | 2023-03-23 | 24396 | Certify to Beta |
0.1.3 | 2023-03-16 | 24155 | Set additionalProperties to True in spec to support BC |
0.1.2 | 2022-07-14 | 0 | Tune the get_view_id function |
0.1.1 | 2021-12-24 | 9101 | Update fields and descriptions |
0.1.0 | 2021-11-03 | 6963 | 🎉 New Source: Freshsales |