Freshservice (Source)
The Freshservice source connector lets you connect to the Freshservice API.
Status
This connector is currently in development. Authentication/credential validation is implemented, but data extraction is not yet available.
Setup
Prerequisites
- A Freshservice account and the subdomain for your Freshservice instance (the
{subdomain}inhttps://{subdomain}.freshservice.com). - A Freshservice API key.
Create an API key in Freshservice
In Freshservice, generate or copy an API key for the user you want to authenticate as. (Freshservice API keys are typically available in the user profile settings.)
Authentication
This connector authenticates to Freshservice using HTTP Basic Auth:
- Username: your Freshservice
api_key - Password: a placeholder value (
X)
During connection setup, the connector validates credentials by calling the Freshservice API (a lightweight request to the tickets endpoint).
Configuration
Provide the following configuration fields:
| Field | Type | Required | Description |
|---|---|---|---|
subdomain | string | ✅ | Your Freshservice subdomain (DNS label only). Example: acme for https://acme.freshservice.com. Must contain only lowercase letters (a-z), digits (0-9), or hyphens (-); cannot start or end with -; max length 63. |
api_key | string | ✅ | Freshservice API key used for Basic Auth. |
Streams
No streams are available yet. Extraction currently returns an error indicating the connector is still in development.
Limitations
- No catalog/stream discovery is currently exposed.
- No extraction is currently supported.