Skip to main content

Zendesk-Chat agent connector

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.

  • 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
  • List all banned visitors
  • What triggers are currently active?
  • Show agent activity timeline for today
  • List all departments with their settings

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

from airbyte_agent_zendesk_chat import ZendeskChatConnector, ZendeskChatAuthConfig

connector = ZendeskChatConnector(
auth_config=ZendeskChatAuthConfig(
access_token="..."
)
)
result = await connector.accounts.get()

Full documentation

This connector supports the following entities and actions.

EntityActions
AccountsGet
AgentsList, Get
Agent TimelineList
BansList, Get
ChatsList, Get
DepartmentsList, Get
GoalsList, Get
RolesList, Get
Routing SettingsGet
ShortcutsList, Get
SkillsList, Get
TriggersList

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-Chat API reference.

Version information

  • Package version: 0.1.4
  • Connector version: 0.1.3
  • Generated with Connector SDK commit SHA: c713ec4833c2b52dc89926ec68caa343423884cd