Installation & Usage
[01]
Install Package
Using uv or pip
BASH
uv pip install airbyte-agent-zendesk-chat
[02]
Import
Initialize and use
PYTHON
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>"
)
)[03]
Tool
Add tools to your agent
python
@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 {})Supported Entities & Actions
Lorem ipsum
Lorem ipsum
| Entity | Actions |\n|--------|---------|\n| Accounts | [Get](./REFERENCE.md#accounts-get) |\n| Agents | [List](./REFERENCE.md#agents-list), [Get](./REFERENCE.md#agents-get), [Search](./REFERENCE.md#agents-search) |\n| Agent Timeline | [List](./REFERENCE.md#agent-timeline-list) |\n| Bans | [List](./REFERENCE.md#bans-list), [Get](./REFERENCE.md#bans-get) |\n| Chats | [List](./REFERENCE.md#chats-list), [Get](./REFERENCE.md#chats-get), [Search](./REFERENCE.md#chats-search) |\n| Departments | [List](./REFERENCE.md#departments-list), [Get](./REFERENCE.md#departments-get), [Search](./REFERENCE.md#departments-search) |\n| Goals | [List](./REFERENCE.md#goals-list), [Get](./REFERENCE.md#goals-get) |\n| Roles | [List](./REFERENCE.md#roles-list), [Get](./REFERENCE.md#roles-get) |\n| Routing Settings | [Get](./REFERENCE.md#routing-settings-get) |\n| Shortcuts | [List](./REFERENCE.md#shortcuts-list), [Get](./REFERENCE.md#shortcuts-get), [Search](./REFERENCE.md#shortcuts-search) |\n| Skills | [List](./REFERENCE.md#skills-list), [Get](./REFERENCE.md#skills-get) |\n| Triggers | [List](./REFERENCE.md#triggers-list), [Search](./REFERENCE.md#triggers-search) |
Example Prompts
Lorem ipsum
List all banned visitors - List all departments with their settings - Show me all chats from last week - List all agents in the support department - What are the most used chat shortcuts? - Show chat volume by department - What triggers are currently active? - Show agent activity timeline for today
Why Airbyte for AI Agents?
Built for production AI workloads with enterprise-grade reliability
Secure Authentication
Built-in OAuth 2.0 handling with automatic token refresh. No hard-coded credentials.
Agent-Native Design
Heading
Structured, LLM-friendly schemas optimized for AI agent consumption with natural language query support.
Production Ready
Battle-tested connectors with comprehensive error handling, logging, and retry logic.
Open Source
Fully open source under the MIT license. Contribute, customize, and extend freely.
Works with your favorite frameworks
LangChain
CrewAI
LlamaIndex
AutoGen
OpenAI Agents SDK
Claude Agents SDK
Frequently Asked Questions
Didn't find your answer? Please don't hesitate to reach out.
The zendesk-chat connector supports OAuth 2.0 authentication via a personal access token. You provide your Zendesk Chat OAuth 2.0 access token directly in the auth config when running in open source mode. In hosted mode, credentials are stored securely in Airbyte Cloud instead.
Can I use this connector with any AI agent framework?
The connector is compatible with any Python-based AI agent framework including LangChain, LlamaIndex, CrewAI, Pydantic AI, and custom implementations.
Does this connector support write operations?
Currently, the zendesk-chat connector focuses on read operations only. Write operations such as starting a new chat session, sending messages to visitors, creating agents, updating department settings, or deleting shortcuts are not supported at this time.
How is this different from the Airbyte data connector?
Agent connectors are specifically designed for AI agents and LLM applications. They provide natural language interfaces, optimized response formats, and seamless integration with agent frameworks, unlike traditional ETL-focused connectors.
Get started in minutes with our open-source connector.