Skip to main content

Airbyte Zendesk-Support Connector for AI platforms

Project description

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
  • What are the top 5 support issues our organization has faced this month?
  • List all unresolved tickets for {customer}
  • Analyze the satisfaction ratings for our support team in the last 30 days
  • Compare ticket resolution times across different support groups
  • Show me the details of recent tickets tagged with {tag}
  • 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.describe
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

connector = ZendeskSupportConnector(
    external_user_id="<your-scoped-token>",
    airbyte_client_id="<your-client-id>",
    airbyte_client_secret="<your-client-secret>"
)

@agent.tool_plain # assumes you're using Pydantic AI
@ZendeskSupportConnector.describe
async def zendesk-support_execute(entity: str, action: str, params: dict | None = None):
    return await connector.execute(entity, action, params or {})

Full documentation

This connector supports the following entities and actions.

Entity Actions
Tickets List, Get
Users List, Get
Organizations List, Get
Groups List, Get
Ticket Comments List
Attachments Get, Download
Ticket Audits List, List
Ticket Metrics List
Ticket Fields List, Get
Brands List, Get
Views List, Get
Macros List, Get
Triggers List, Get
Automations List, Get
Tags List
Satisfaction Ratings List, Get
Group Memberships List
Organization Memberships List
Sla Policies List, Get
Ticket Forms List, Get
Articles List, Get
Article Attachments List, Get, Download

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

For detailed documentation on available actions and parameters, see this connector's full reference documentation.

For the service's official API docs, see the Zendesk-Support API reference.

Version information

  • Package version: 0.18.60
  • Connector version: 0.1.8
  • Generated with Connector SDK commit SHA: 592446b89cdadb961d5a035ee4333ae1f5c074ce

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.60.tar.gz (160.5 kB view details)

Uploaded Source

Built Distribution

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

airbyte_agent_zendesk_support-0.18.60-py3-none-any.whl (173.6 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for airbyte_agent_zendesk_support-0.18.60.tar.gz
Algorithm Hash digest
SHA256 01d9f841cb77267c467116bfc1917d98fc011a9c87300ac544f7616ae0683d2a
MD5 cde0fa2d2f8e3b39bce32c6957b69095
BLAKE2b-256 00d11c1740950b1cdb6335fe6b5188427a6878ad63a0c42f8f2bb3ef2f7169aa

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for airbyte_agent_zendesk_support-0.18.60-py3-none-any.whl
Algorithm Hash digest
SHA256 139a629507e760fcd684db329ebdf4f41383637d8959c27c1031436452b12191
MD5 6e5e6c2c53111c0437a51283bfb33925
BLAKE2b-256 166f7aba951eb267eb1faef4138ae367bd6b3f75d290753e4694119b1e36d88d

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