airbyte-agent-zendesk-support 0.18.98

Airbyte Zendesk-Support Connector for AI platforms

Zendesk-Support agent connector

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.

Example questions

The Zendesk-Support connector is optimized to handle prompts like these.

• Show me the tickets assigned to me last week
• List all unresolved tickets
• Show me the details of recent tickets
• What are the top 5 support issues our organization has faced this month?
• Analyze the satisfaction ratings for our support team in the last 30 days
• Compare ticket resolution times across different support groups
• Identify the most common ticket fields used in our support workflow
• Summarize the performance of our SLA policies this quarter

Unsupported questions

The Zendesk-Support connector isn't currently able to handle prompts like these.

• Create a new support ticket for {customer}
• Update the priority of this ticket
• Assign this ticket to {team_member}
• Delete these old support tickets
• Send an automatic response to {customer}

Installation

uv pip install airbyte-agent-zendesk-support

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_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 {})

Hosted

In hosted mode, API credentials are stored securely in Airbyte Cloud. You provide your Airbyte credentials instead.

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(
        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
@ZendeskSupportConnector.tool_utils
async def zendesk_support_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
Tickets	List, Get, 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

Authentication and configuration

For all authentication and configuration options, see the connector's authentication documentation.

Zendesk-Support API docs

See the official Zendesk-Support API reference.

Version information

• Package version: 0.18.98
• Connector version: 0.1.13
• Generated with Connector SDK commit SHA: 04691d063af9e36703f1d2a66e2a1df8e9e52dbe
• Changelog: View changelog