JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 73
  • Score
    100M100P100Q80666F
  • License MIT

A JS library for interacting with the Zendesk API.

Package Exports

  • @androozka/zendesk-api-js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@androozka/zendesk-api-js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

@androozka/zendesk-api-js

npm Build Status codecov David install size npm downloads Twitter Follow

A JS library for interacting with the Zendesk API.

Features

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

  • Search
  • Users
  • Tickets
  • Ticket Metrics
  • Tags

Under Construction

  • Views
  • Organizations
  • Groups
  • Ticket Forms
  • Ticket Fields
  • User Fields
  • Organization Fields
  • Brands
  • User Identities
  • User Passwords
  • End Users
  • Group Memberships
  • Custom Agent Roles
  • Organization Subscriptions
  • Organization Memberships
  • Requests
  • Ticket Audits
  • Ticket Comments
  • Ticket Skips
  • Ticket Metric Events
  • Ticket Activities
  • Ticket Import
  • Attachments
  • Satisfaction Ratings
  • Satisfaction Reasons
  • Suspended Tickets
  • 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