@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
• No dependencies

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 headers = {
  'Content-Type': 'application/json',
  Authorization: `Basic ${base64.encode(`${email}/token:${token}`)}`
};

Choose framework version

const zaf_v2 = zdApi.v2({ instance, headers });

Selecting API endpoints

const { support, sunshine } = zaf_v2;

Examples

Add tags to a ticket

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

API Coverage Status

Support API

• [x] Search
• [ ] Users
• [ ] User Identities
• [ ] User Passwords
• [ ] End Users
• [ ] Groups
• [ ] Group Memberships
• [ ] Custom Agent Roles
• [ ] Organizations
• [ ] Organization Subscriptions
• [ ] Organization Memberships
• [ ] Requests
• [x] Tickets
• [ ] Ticket Import
• [ ] Attachments
• [ ] Satisfaction Ratings
• [ ] Satisfaction Reasons
• [ ] Suspended Tickets
• [ ] Ticket Audits
• [ ] Ticket Comments
• [ ] Ticket Skips
• [x] Ticket Metrics
• [ ] Ticket Metric Events
• [ ] Ticket Activities
• [ ] Sessions
• [x] Tags
• [ ] Views
• [ ] Triggers
• [ ] Automations
• [ ] SLA Policies
• [ ] Targets
• [ ] Target Failures
• [ ] Macros
• [ ] Brands
• [ ] Dynamic Content
• [ ] Locales
• [ ] Schedules
• [ ] Sharing Agreements
• [ ] Support Addresses
• [ ] Ticket Forms
• [ ] Ticket Fields
• [ ] User Fields
• [ ] Organization Fields
• [ ] 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

ToDo

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