docs/ai-agents/connectors/zendesk-support/README.md
The Zendesk-Support agent connector is a Python package that equips AI agents to interact with Zendesk-Support 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 Support is a customer service platform that helps businesses manage support tickets, customer interactions, and help center content. This connector provides access to tickets, users, organizations, groups, comments, attachments, automations, triggers, macros, views, satisfaction ratings, SLA policies, and help center articles for customer support analytics and service performance insights.
The Zendesk-Support connector is optimized to handle prompts like these.
The Zendesk-Support connector isn't currently able to handle prompts like these.
uv pip install airbyte-agent-zendesk-support
Connectors can run in open source or hosted mode.
In open source mode, you provide API credentials directly to the connector.
from airbyte_agent_zendesk_support import ZendeskSupportConnector
from airbyte_agent_zendesk_support.models import ZendeskSupportApiTokenAuthConfig
connector = ZendeskSupportConnector(
auth_config=ZendeskSupportApiTokenAuthConfig(
email="<Your Zendesk account email address>",
api_token="<Your Zendesk API token from Admin Center>"
)
)
@agent.tool_plain # assumes you're using Pydantic AI
@ZendeskSupportConnector.tool_utils
async def zendesk_support_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
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_support import ZendeskSupportConnector, AirbyteAuthConfig
connector = ZendeskSupportConnector(
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
@ZendeskSupportConnector.tool_utils
async def zendesk_support_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})
This connector supports the following entities and actions. For more details, see this connector's full reference documentation.
| Entity | Actions |
|---|---|
| Tickets | List, Get, Search |
| Deleted Tickets | List, Search |
| Users | List, Get, Search |
| Organizations | List, Get, Search |
| Groups | List, Get, Search |
| Ticket Comments | List, Search |
| Attachments | Get, Download |
| Ticket Audits | List, List, Search |
| Ticket Metrics | List, Search |
| Ticket Fields | List, Get, Search |
| Brands | List, Get, Search |
| Views | List, Get |
| Macros | List, Get |
| Triggers | List, Get |
| Automations | List, Get |
| Tags | List, Search |
| Satisfaction Ratings | List, Get, Search |
| Group Memberships | List |
| Organization Memberships | List |
| Sla Policies | List, Get |
| Ticket Forms | List, Get, Search |
| Articles | List, Get |
| Article Attachments | List, Get, Download |
For all authentication options, see the connector's authentication documentation.
See the official Zendesk-Support API reference.