Freshdesk authentication

This connector is optimized for AI agents. For the data replication connector, see Freshdesk.

This page documents the authentication and configuration options for the Freshdesk agent connector.

Authentication

Open source execution

In open source mode, you provide API credentials directly to the connector.

OAuth

This authentication method isn't available for this connector.

Token

credentials fields you need:

Field Name	Type	Required	Description
`api_key`	`str`	Yes	Your Freshdesk API key (found in Profile Settings)

Example request:

from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector
from airbyte_agent_sdk.connectors.freshdesk.models import FreshdeskAuthConfig

connector = FreshdeskConnector(
    auth_config=FreshdeskAuthConfig(
        api_key="<Your Freshdesk API key (found in Profile Settings)>"
    )
)

Hosted execution

In hosted mode, you first create a connector via the Airbyte Agent API (providing your OAuth or Token credentials), then execute operations using either the Python SDK or API. If you need a step-by-step guide, see the developer quickstart.

OAuth

This authentication method isn't available for this connector.

Bring your own OAuth flow

This authentication method isn't available for this connector.

Token

Create a connector with Token credentials.

credentials fields you need:

Field Name	Type	Required	Description
`api_key`	`str`	Yes	Your Freshdesk API key (found in Profile Settings)

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
  -H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "workspace_name": "<WORKSPACE_NAME>",
    "connector_type": "Freshdesk",
    "name": "My Freshdesk Connector",
    "credentials": {
      "api_key": "<Your Freshdesk API key (found in Profile Settings)>"
    }
  }'

Execution

After creating the connector, execute operations using either the Python SDK or API. If your Airbyte client can access multiple organizations, include organization_id in AirbyteAuthConfig and X-Organization-Id in raw API calls.

Python SDK

The connect() factory returns a fully typed FreshdeskConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

Pydantic AI
LangChain
OpenAI Agents
FastMCP

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector

connector = connect("freshdesk", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

LangChain
from langchain_core.tools import tool
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector

connector = connect("freshdesk", workspace_name="<your_workspace_name>")

@tool
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    # connector.execute returns a Pydantic envelope for typed actions; fall back to raw data otherwise.
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

OpenAI Agents
from agents import Agent, function_tool
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector

connector = connect("freshdesk", workspace_name="<your_workspace_name>")

# strict_mode=False because `params: dict` is permissive and the default strict
# JSON schema rejects objects with additionalProperties.
@function_tool(strict_mode=False)
@FreshdeskConnector.tool_utils(framework="openai_agents")
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

agent = Agent(name="Freshdesk Assistant", tools=[freshdesk_execute])

FastMCP
from fastmcp import FastMCP
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector

connector = connect("freshdesk", workspace_name="<your_workspace_name>")

mcp = FastMCP("Freshdesk Agent")

@mcp.tool
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment): Pydantic AI

Pydantic AI
LangChain
OpenAI Agents
FastMCP

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = FreshdeskConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

LangChain
from langchain_core.tools import tool
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = FreshdeskConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

@tool
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    # connector.execute returns a Pydantic envelope for typed actions; fall back to raw data otherwise.
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

OpenAI Agents
from agents import Agent, function_tool
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = FreshdeskConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

# strict_mode=False because `params: dict` is permissive and the default strict
# JSON schema rejects objects with additionalProperties.
@function_tool(strict_mode=False)
@FreshdeskConnector.tool_utils(framework="openai_agents")
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

agent = Agent(name="Freshdesk Assistant", tools=[freshdesk_execute])

FastMCP
from fastmcp import FastMCP
from airbyte_agent_sdk.connectors.freshdesk import FreshdeskConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = FreshdeskConnector(
    auth_config=AirbyteAuthConfig(
        workspace_name="<your_workspace_name>",
        organization_id="<your_organization_id>",  # Optional for multi-org clients
        airbyte_client_id="<your-client-id>",
        airbyte_client_secret="<your-client-secret>"
    )
)

mcp = FastMCP("Freshdesk Agent")

@mcp.tool
@FreshdeskConnector.tool_utils
async def freshdesk_execute(entity: str, action: str, params: dict | None = None):
    """Execute Freshdesk connector operations."""
    result = await connector.execute(entity, action, params or {})
    return result.model_dump(mode="json") if hasattr(result, "model_dump") else result

API

curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
  -H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
  -H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
  -H 'Content-Type: application/json' \
  -d '{"entity": "<entity>", "action": "<action>", "params": {}}'

Configuration

The Freshdesk connector requires the following configuration variables. These variables are used to construct the base API URL. Pass them via the config parameter when initializing the connector.

Variable	Type	Required	Default	Description
`subdomain`	`string`	Yes	your-subdomain	Your Freshdesk subdomain (e.g., "acme" for acme.freshdesk.com)

Authentication​

Open source execution​

OAuth​

Token​

Hosted execution​

OAuth​

Bring your own OAuth flow​

Token​

Execution​

Configuration​

Authentication

Open source execution

OAuth

Token

Hosted execution

OAuth

Bring your own OAuth flow

Token

Execution

Configuration