Zendesk

Learn how to use Zendesk with Composio

Overview

SLUG: ZENDESK

Description

Zendesk provides customer support software with ticketing, live chat, and knowledge base features, enabling efficient helpdesk operations and customer engagement

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to organizations:read,organizations:write,tickets:read,tickets:write,users:read,users:write,webhooks:read,webhooks:write
bearer_token
string
subdomain
stringRequired

Connecting to Zendesk

Create an auth config

Use the dashboard to create an auth config for the Zendesk toolkit. This allows you to connect multiple Zendesk accounts to Composio for agents to use.

1

Select App

Navigate to the Zendesk toolkit page and click “Setup Integration”.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Integration”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2from composio.types import auth_scheme
3
4# Replace these with your actual values
5zendesk_auth_config_id = "ac_YOUR_ZENDESK_CONFIG_ID" # Auth config ID created above
6user_id = "0000-0000-0000" # UUID from database/application
7
8composio = Composio()
9
10
11def authenticate_toolkit(user_id: str, auth_config_id: str):
12 connection_request = composio.connected_accounts.initiate(
13 user_id=user_id,
14 auth_config_id=auth_config_id,
15 )
16
17 print(
18 f"Visit this URL to authenticate Zendesk: {connection_request.redirect_url}"
19 )
20
21 # This will wait for the auth flow to be completed
22 connection_request.wait_for_connection(timeout=15)
23 return connection_request.id
24
25
26connection_id = authenticate_toolkit(user_id, zendesk_auth_config_id)
27
28# You can also verify the connection status using:
29connected_account = composio.connected_accounts.get(connection_id)
30print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Zendesk toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["ZENDESK"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Count Zendesk Organizations

Description

Count the number of organizations in zendesk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Tickets

Description

List zendesk tickets with pagination and filtering.

Action Parameters

external_id
string
page
integer
per_page
integer
sort_by
string
sort_order
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Zendesk Organization

Description

Create an organization in zendesk.

Action Parameters

external_id
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Zendesk Ticket

Description

Create a ticket in zendesk.

Action Parameters

description
stringRequired
priority
stringDefaults to normal
requester_email
string
requester_name
string
subject
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Zendesk Organization

Description

Delete an organization in zendesk.

Action Parameters

organization_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Zendesk Ticket

Description

Delete a ticket in zendesk.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Zendesk About Me

Description

Get information about the owner account in zendesk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Zendesk Organizations

Description

Get all organizations in zendesk.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Zendesk Organization

Description

Get information about a specific organization in zendesk.

Action Parameters

organization_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Zendesk Ticket

Description

Get ticket details from zendesk.

Action Parameters

ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Reply to Zendesk Ticket

Description

Action to reply to a zendesk ticket by adding a comment.

Action Parameters

body
string
public
booleanDefaults to True
ticket_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Zendesk Organization

Description

Update an organization in zendesk.

Action Parameters

data
objectRequired
organization_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired