Skip to main content
Connect Zendesk to let the AI retrieve ticket/user details (lookups) and perform approved updates (actions).

​
On this page

​
Connect

1

Log in as an admin and go to the admin section

You need permissions to access the admin section and create OAuth clients.
2

Open the OAuth clients page

Navigate to Apps and Integrations → APIs → OAuth clientsOAuth clients page
3

Create a new OAuth client

Click Add OAuth client and fill out the details.
Make sure to set the Client kind to Confidential.
After you click Save, you’ll be shown a secret at the end of the page. It’s only shown once—copy and store it securely.
4

Connect Zendesk in Typewise

In Typewise, go to Integrations, find Zendesk, and click Connect. You’ll need:Connect Zendesk
  • Subdomain: The first part of your Zendesk URL. For example, for https://acme.zendesk.com/admin/home, the subdomain is acme.
  • Client ID: The identifier you set when creating the OAuth client. Client ID
  • Client Secret: The secret shown once after saving the OAuth client. Client Secret
After you click Install, Zendesk should be connected successfully.

​
Supported tools

The following tools are available through the Zendesk integration.

​
Lookups

Retrieve a Zendesk ticket by its ID.
ParameterDescriptionRequiredDefault
ticket_idThe ID of the ticket to retrieve.Yes—
Retrieve all comments for a Zendesk ticket.
ParameterDescriptionRequiredDefault
ticket_idThe ID of the ticket to get comments for.Yes—
Search for Zendesk Help Center articles.
ParameterDescriptionRequiredDefault
queryThe search query.Yes—
max_resultsMaximum number of results to return.No5
Get information about a Zendesk user.
ParameterDescriptionRequiredDefault
user_idThe ID of the user to retrieve information for.Yes—

​
Actions

Update the email address of a Zendesk sender.
ParameterDescriptionRequiredDefault
sender_idThe ID of the sender to update.Yes—
new_emailThe new email to update the sender to.Yes—