Zendesk-Chat
The Zendesk-Chat agent connector is a Python package that equips AI agents to interact with Zendesk-Chat through strongly typed, well-documented tools. It's ready to use directly in your Python app, in an agent framework, or exposed through an MCP.
Zendesk Chat enables real-time customer support through live chat. This connector provides access to chat transcripts, agents, departments, shortcuts, triggers, and other chat configuration data for analytics and support insights.
Supported Entities
- accounts: Account information and billing details
- agents: Chat agents with roles and department assignments
- agent_timeline: Agent activity timeline (incremental export)
- bans: Banned visitors (IP and visitor-based)
- chats: Chat transcripts with full conversation history (incremental export)
- departments: Chat departments for routing
- goals: Conversion goals for tracking
- roles: Agent role definitions
- routing_settings: Account-level routing configuration
- shortcuts: Canned responses for agents
- skills: Agent skills for skill-based routing
- triggers: Automated chat triggers
Rate Limits
Zendesk Chat API uses the Retry-After header for rate limit backoff.
The connector handles this automatically.
Example questions
The Zendesk-Chat connector is optimized to handle prompts like these.
- 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
Unsupported questions
The Zendesk-Chat connector isn't currently able to handle prompts like these.
- Start a new chat session
- Send a message to a visitor
- Create a new agent
- Update department settings
- Delete a shortcut
Installation
uv pip install airbyte-agent-zendesk-chat
Usage
Connectors can run in open source or hosted mode.
Open source
In open source mode, you provide API credentials directly to the connector.
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>"
)
)
@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 {})
Hosted
In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.
If your Airbyte client can access multiple organizations, also set organization_id.
This example assumes you've already authenticated your connector with Airbyte. See Authentication to learn more about authenticating. If you need a step-by-step guide, see the hosted execution tutorial.
from airbyte_agent_zendesk_chat import ZendeskChatConnector, AirbyteAuthConfig
connector = ZendeskChatConnector(
auth_config=AirbyteAuthConfig(
customer_name="<your_customer_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
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 {})
Full documentation
Entities and actions
This connector supports the following entities and actions. For more details, see this connector's full reference documentation.
| Entity | Actions |
|---|---|
| Accounts | Get |
| Agents | List, Get, Context Store Search |
| Agent Timeline | List |
| Bans | List, Get |
| Chats | List, Get, Context Store Search |
| Departments | List, Get, Context Store Search |
| Goals | List, Get |
| Roles | List, Get |
| Routing Settings | Get |
| Shortcuts | List, Get, Context Store Search |
| Skills | List, Get |
| Triggers | List, Context Store Search |
Authentication
For all authentication options, see the connector's authentication documentation.
Zendesk-Chat API docs
See the official Zendesk-Chat API reference.
Version information
- Package version: 0.1.80
- Connector version: 0.1.10
- Generated with Connector SDK commit SHA: c5258debd165ab701252c1436d4acfb475bf92b9
- Changelog: View changelog
Metadata
Release files for airbyte-agent-zendesk-chat 0.1.80
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| airbyte_agent_zendesk_chat-0.1.80.tar.gz | 166.5 kB | Without provenance | Details for airbyte_agent_zendesk_chat-0.1.80.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| airbyte_agent_zendesk_chat-0.1.80-py3-none-any.whl | Python 3 | none | any | Details for airbyte_agent_zendesk_chat-0.1.80-py3-none-any.whl |
Total release size: 357.4 kB
Release files / airbyte_agent_zendesk_chat-0.1.80.tar.gz
| Download URL | airbyte_agent_zendesk_chat-0.1.80.tar.gz |
|---|---|
| Size | 166.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5b3b3f3fba3e2eb88f783b32606daf230fe74f88fa87ccfb2e59b3f44fb9da26
|
|
BLAKE2b-256 checksum How to use checksums |
f247ff859e3d672e0e95ad896919da78a6864774b0afd2d645f0360c2bee4a6c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.12
|
Release files / airbyte_agent_zendesk_chat-0.1.80-py3-none-any.whl
| Download URL | airbyte_agent_zendesk_chat-0.1.80-py3-none-any.whl |
|---|---|
| Size | 190.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
dfb93b1d671516e2142db5be735ee56dcc26d3eea1d452efd1823b85a7857628
|
|
BLAKE2b-256 checksum How to use checksums |
b478713683b55c852b53a9265eaa1911328f94d75c5d2f70fd89f2ef1a72609e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.12
|
Security for airbyte-agent-zendesk-chat 0.1.80
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.