Skip to content
Clients

Zendesk Client

@theholocron/zendesk-client is a typed wrapper around the Zendesk Support API for managing tickets, statuses, fields, and search.

Install

Terminal window
pnpm add @theholocron/zendesk-client

Usage

import { createZendeskClient, createToken } from "@theholocron/zendesk-client";


const client = createZendeskClient({
  baseUrl: "https://myorg.zendesk.com",
  token: createToken(process.env.ZENDESK_EMAIL, process.env.ZENDESK_API_TOKEN),
});


const tickets = await client.tickets.list();
const ticket = await client.tickets.get(12345);
await client.tickets.create({ subject: "Help needed", body: "Details here" });


const results = await client.search.query("type:ticket status:open");

Authentication

Use the exported createToken() helper to build the token from an email address and API token. Passing a raw API token directly will not work:

import { createToken } from "@theholocron/zendesk-client";


const token = createToken(process.env.ZENDESK_EMAIL, process.env.ZENDESK_API_TOKEN);

Generate an API token at Zendesk Admin Center → Apps and integrations → APIs → Zendesk API. The baseUrl is your Zendesk subdomain, e.g. https://myorg.zendesk.com.

Namespaces

Namespace Methods
activities get
comments list, create
fields list, get, create, update, delete
search query
status list, get, create, update
tickets list, get, create, update, delete