Skip to main content

Airbyte Zendesk-Support Connector for AI platforms

Project description

Zendesk-Support

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.

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

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, Context Store Search
Deleted Tickets List, Context Store Search
Users List, Get, Context Store Search
Organizations List, Get, Context Store Search
Groups List, Get, Context Store Search
Ticket Comments List, Context Store Search
Attachments Get, Download
Ticket Audits List, List, Context Store Search
Ticket Metrics List, Context Store Search
Ticket Fields List, Get, Context Store Search
Brands List, Get, Context Store Search
Views List, Get
Macros List, Get
Triggers List, Get
Automations List, Get
Tags List, Context Store Search
Satisfaction Ratings List, Get, Context Store Search
Group Memberships List
Organization Memberships List
Sla Policies List, Get
Ticket Forms List, Get, Context Store Search
Articles List, Get
Article Attachments List, Get, Download

Authentication

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

Zendesk-Support API docs

See the official Zendesk-Support API reference.

Version information

  • Package version: 0.18.135
  • Connector version: 0.1.20
  • Generated with Connector SDK commit SHA: 6bf360a546d577c9f76e8a6b8abf9ffc4dbfcf3a
  • Changelog: View changelog

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

airbyte_agent_zendesk_support-0.18.135.tar.gz (213.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file airbyte_agent_zendesk_support-0.18.135.tar.gz.

File metadata

File hashes

Hashes for airbyte_agent_zendesk_support-0.18.135.tar.gz
Algorithm Hash digest
SHA256 9ad005df47c96b6f3df48b1659c8f91e7108f34922ea4b4b0827c559c5262a16
MD5 5fbcb96f35d14d57c2c92c923e8b9649
BLAKE2b-256 cb5f0efebe903a384dfcaa64658ca9cb6b23ace9e31ce6f32ba670c2a3e1e0eb

See more details on using hashes here.

File details

Details for the file airbyte_agent_zendesk_support-0.18.135-py3-none-any.whl.

File metadata

File hashes

Hashes for airbyte_agent_zendesk_support-0.18.135-py3-none-any.whl
Algorithm Hash digest
SHA256 fb8fd55da0f684e228172fb3ae4d043c36c0090a1196d1aec062a0e03e0cfab7
MD5 3743d0db388123642c9b3bbcd6e23c68
BLAKE2b-256 71121245ca99c176a634cc261c160442a70c1dc4a784b3dd49ca9b0e91cfa174

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page