@androozka/zendesk-api-js

A JS library for interacting with the Zendesk API.

Features

• Generates Zendesk API request objects 😎
• Send prepared object directly to axios 🤯
• Mirrors Zendesk's API documentation 👀

Installing

Using npm

npm install @androozka/zendesk-api-js

Using yarn

yarn add @androozka/zendesk-api-js

Usage

Suggested libraries

const base64 = require('js-base64').Base64;
const axios = require('axios');

Zendesk account information

const instance = ''; // Name of Zendesk instance
const email = ''; // Email address of Zendesk user
const token = ''; // Generated Zendesk token

const encoded = base64.encode(`${email}/token:${token}`);

const headers = {
  'Content-Type': 'application/json',
  Authorization: `Basic ${encoded}`
};

Choose framework version

const zdApi = require('@androozka/zendesk-api-js');
const zaf_v2 = zdApi.v2({ instance, headers });

• Note: Only v2, v1 being deprecated

Selecting API endpoints

const { support, sunshine } = zaf_v2;

Examples

Add tags to a ticket

try {
  const data = { tags: ['tag_1', 'tag_2', ... ] }
  const req = support.tags.add({ type: 'tickets', id: 123, data });
  const res = await axios(req);
} catch (error) {
  // ...
}

API Coverage Status

Support API

Search, Users, End Users, Groups, Group Memberships, Custom Agent Roles, Organizations, Tickets, Ticket Import, Suspended Tickets, Ticket Comments, Ticket Metrics, Ticket Activities, Tags, Views, Ticket Forms, Ticket Fields, User Fields, Organization Fields

Under Construction

• [ ] Brands
• [ ] User Identities
• [ ] User Passwords
• [ ] Organization Subscriptions
• [ ] Organization Memberships
• [ ] Requests
• [ ] Ticket Audits
• [ ] Ticket Skips
• [ ] Ticket Metric Events
• [ ] Attachments
• [ ] Satisfaction Ratings
• [ ] Satisfaction Reasons
• [ ] Sessions
• [ ] Triggers
• [ ] Automations
• [ ] SLA Policies
• [ ] Targets
• [ ] Target Failures
• [ ] Macros
• [ ] Dynamic Content
• [ ] Locales
• [ ] Schedules
• [ ] Sharing Agreements
• [ ] Support Addresses
• [ ] Job Statuses
• [ ] Skill-based Routing
• [ ] Incremental Skill-based Routing
• [ ] Workspaces
• [ ] Apps
• [ ] App Installation Locations
• [ ] App Locations
• [ ] OAuth Clients
• [ ] OAuth Tokens
• [ ] OAuth Tokens for Grant Types
• [ ] Authorized Global Clients
• [ ] Account Settings
• [ ] Audit Logs
• [ ] Bookmarks
• [ ] Push Notification Devices
• [ ] Resource Collections
• [ ] Channel Framework
• [ ] Twitter Channel

APIs Up Next

• Sunshine API
• Help Center API
• Chat API
• Talk API
• Sell API
• Answer Bot API
• Status API
• Reseller API
• NPS API