To help you get started, we've collected the most common ways that node-zendesk is being used within popular public projects.

rakutentech / docpub / lib / zendesk-uploader / api-utils.js View on Github

const getClient = function(config) {
    if (!config) {
        throw new Error('Unable to configure ZenDesk client without a config');
    }

    const options = {
        username: config.username,
        token: config.token,
        remoteUri: buildHelpCenterUri(config.url),
        helpcenter: true, // In order to use Help Center APIs, this varialbe must be set to `true` AND `remoteUri` must be set to the Help Center endpoint
        disableGlobalState: true // Run as Library only - not scriptrunner
    };
    const client = zendesk.createClient(options);

    return new ZendeskClientWrapper(client);
};

View more ways to use node-zendesk

node-zendesk

A Zendesk API client library for use with node.js

node-zendesk is a versatile gateway between Node.js and the Zendesk Customer Support Platform. Primarily designed for seamless integration with Node.js applications, it also excels in transforming, accessing, and packaging various Zendesk resources and assets. Beyond its core function, it stands ready to bridge the gap between development and Zendesk's powerful capabilities.

Read the full documentation at blakmatrix.github.io/node-zendesk/

Install

To use the API, just do the standard

npm install --save node-zendesk

Example

var zendesk = require('node-zendesk');
// or `import {createClient} from 'node-zendesk'` if using typescript

var client = zendesk.createClient({
  username:  'username',
  token:     'token',
  subdomain: 'subdomain'
});

client.users.list().then(users => {
  console.log('Total Users:', users.length);
  console.log('User Names:', users.map(user => user.name));
}).catch(error => {
  console.error(`Failed to get list of users: ${error.message}`);
});

Take a look in the examples folder for more examples.

Getting Started

If you're new to node-zendesk, we recommend checking out our Getting Started Guide to help you set up and familiarize yourself with the library.

Contributions

If you're looking to contribute, please refer to the API Coverage Document, open an issue, or make a PR!

Tests and examples are also welcome.

Zendesk's documentation can be found here.

🌟 Support Our Project!

🎉 Join our community of supporters, backers, and sponsors to help fuel the growth and sustainability of our open-source project. Your contribution, no matter the size, makes a meaningful impact:

• Supporters ($1/month): Even a small contribution helps us continue our mission. Every dollar adds up!
• Backers ($5/month): Take your support up a notch and gain exclusive updates and features.
• Sponsors ($100/month): Champion the project's progress, get prominent recognition, and shape its future.

By becoming a supporter, backer, or sponsor, you're investing in the innovation and excellence of our project. Together, we can drive meaningful change and empower developers worldwide.

🚀 Join Us | Learn More

License

MIT.