Zendesk-Chat authentication and configuration

This page documents the authentication and configuration options for the Zendesk-Chat agent connector.

Authentication

Open source execution

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

OAuth

credentials fields you need:

Field Name	Type	Required	Description
access_token	str	Yes	Your Zendesk Chat OAuth 2.0 access token

Example request:

from airbyte_agent_zendesk-chat import ZendeskChatConnector
from airbyte_agent_zendesk-chat.models import ZendeskChatAuthConfig

connector = ZendeskChatConnector(
    auth_config=ZendeskChatAuthConfig(
        access_token="<Your Zendesk Chat OAuth 2.0 access token>"
    )
)

Token

This authentication method isn't available for this connector.

Hosted execution

In hosted mode, you first create a connector via the Airbyte 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 hosted execution tutorial.

OAuth

Create a connector with OAuth credentials.

credentials fields you need:

Field Name	Type	Required	Description
access_token	str	Yes	Your Zendesk Chat OAuth 2.0 access token

replication_config fields you need:

Field Name	Type	Required	Description
start_date	str (date-time)	Yes	The date from which to start replicating data, in the format YYYY-MM-DDT00:00:00Z.

Example request:

curl -X POST "https://api.airbyte.ai/v1/integrations/connectors" \
  -H "Authorization: Bearer <SCOPED_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "external_user_id": "<EXTERNAL_USER_ID>",
    "connector_type": "Zendesk-Chat",
    "name": "My Zendesk-Chat Connector",
    "credentials": {
      "access_token": "<Your Zendesk Chat OAuth 2.0 access token>"
    },
    "replication_config": {
      "start_date": "<The date from which to start replicating data, in the format YYYY-MM-DDT00:00:00Z.>"
    }
  }'

Token

This authentication method isn't available for this connector.

Execution

After creating the connector, execute operations using either the Python SDK or API.

Python SDK

from airbyte_agent_zendesk-chat import ZendeskChatConnector

connector = ZendeskChatConnector(
    external_user_id="<your_external_user_id>",
    airbyte_client_id="<your-client-id>",
    airbyte_client_secret="<your-client-secret>"
)

@agent.tool_plain # assumes you're using Pydantic AI
@ZendeskChatConnector.tool_utils
async def zendesk-chat_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

API

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

Configuration

The Zendesk-Chat 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 Zendesk subdomain (the part before .zendesk.com in your Zendesk URL)