@androozka/zendesk-api-js

    2.0.3 • Public • Published

    @androozka/zendesk-api-js

    npm Travis (.com) codecov David install size npm downloads Twitter Follow

    A JS library for interacting with the Zendesk API.

    Features

    Note: Only v2 framework, v1 deprecated

    Installing

    # using npm 
    npm install @androozka/zendesk-api-js
     
    # using yarn 
    yarn add @androozka/zendesk-api-js

    Usage

    Getting Started

    const axios = require('axios'); // Suggested library
    const zdApi = require('@androozka/zendesk-api-js');

    Zendesk Info

    const options = {
      instance: '', // Zendesk subdomain
      email: '', // User account to perform requests
      password: '', // Password for user account
      token: '' // Generated Zendesk token
    };
    /* Note: Either "password" or "token" is required */

    Initalize

    // Load entire library
    const { support, sunshine } = zdApi.init(options);
     
    // Load entire API
    const { tickets, groups } = zdApi.support.init(options);
     
    // Load specific endpoint
    const { list, create } = zdApi.support.tickets(options);

    Examples

    Add tags to a ticket

    try {
      const { tags } = zdApi.support.init(options);
      const data = { tags: ['tag_1', 'tag_2', ... ] }
     
      const req = 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, Organization Subscriptions, Organization Memberships, Tickets, Ticket Import, Satisfaction Ratings, Satisfaction Reasons, Suspended Tickets, Ticket Audits, Ticket Comments, Ticket Skips, Ticket Metrics, Ticket Metric Events, Ticket Activities, Tags, Views, Automations, SLA Policies, Targets, Target Failures, Brands, Locales, Schedules, Sharing Agreements, Support Addresses, Ticket Forms, Ticket Fields, User Fields, Organization Fields, Job Statuses, Incremental Skill-based Routing, Workspaces, App Installation Locations, App Locations, Account Settings, Audit Logs, Bookmarks, Twitter Channel

    Sunshine API

    Custom Object Types, Custom Object Records, Relationship Types, Relationship Records, Custom Objects Events

    Under Construction

    Support

    • User Identities
    • User Passwords
    • Requests
    • Attachments
    • Sessions
    • Triggers
    • Macros
    • Dynamic Content
    • Skill-based Routing
    • Apps
    • OAuth Clients
    • OAuth Tokens
    • OAuth Tokens for Grant Types
    • Authorized Global Clients
    • Push Notification Devices
    • Resource Collections
    • Channel Framework

    Sunshine

    • Jobs
    • Limits
    • Events
    • Profiles
    • People

    APIs Up Next

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

    Install

    npm i @androozka/zendesk-api-js

    DownloadsWeekly Downloads

    26

    Version

    2.0.3

    License

    MIT

    Unpacked Size

    200 kB

    Total Files

    69

    Last publish

    Collaborators

    • androozka