node-zendesk

You can enable or disable detailed debug logging by setting the debug property in the client configuration object. When set to true, the client will output additional diagnostic information to help troubleshoot issues.

const clientOptions = {
  debug: true
};

By default, node-zendesk uses the core API. To access other Zendesk APIs such as helpdesk, services, or voice, you must explicitly include them in the apiType array during client instantiation via the zendesk.createClient method.

Available API types:

• core (default)
• helpdesk
• services
• voice

const clientOptions = {
  username: 'your_username',
  token: 'your_token',
  subdomain: 'your_subdomain',
  apiType: ['core', 'helpdesk', 'services', 'voice'],
};
const client = zendesk.createClient(clientOptions);

When initializing the Zendesk client, you can include an object of additional HTTP headers by using the customHeaders key within the client options object. This allows you to pass arbitrary headers (e.g., for authentication, tracing, or custom middleware requirements) with every request made by the client.

const clientOptions = {
  customHeaders: {
    'X-Custom-Header': 'CustomValue'
  }
};

To add node-zendesk to your project, install it as a dependency using npm. This makes the library available for import in your application code.

npm install --save node-zendesk

Side-loading enables you to retrieve related records (such as groups or roles) in the same request as your primary record query. To enable this, call the setSideLoad method on the relevant resource collection (e.g., client.users) and pass an array of strings representing the names of the related records you wish to include.

client.users.setSideLoad(['group', 'role']);

To use an OAuth token instead of a username/token pair, pass the OAuth token to the token key and set the oauth option to true when calling createClient.

var zendesk = require('node-zendesk');

var client = zendesk.createClient({
  token:     'your_oauth_token',
  oauth: true
});

To make API requests on behalf of a specific end user, you must use OAuth authentication with the impersonate scope granted. When creating the client, provide the end user's email address in the asUser property.

var zendesk = require('node-zendesk');

var client = createClient({
  username:  'your_username',
  token:     'your_oauth_token',
  subdomain: 'your_subdomain',
  oauth: true,
  asUser: 'end-user@example.com'
});

You can quickly set up access to the Zendesk API using a combination of your username, an API token, and your Zendesk subdomain. This is the standard method for administrative or service-account access.

var zendesk = require('node-zendesk');

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

By default, node-zendesk optimizes pagination for efficient retrieval of large datasets. If you need to customize the pagination behavior, you can pass a query object to the zendesk.createClient options during instantiation. This allows you to specify parameters like page.size.

Warning: Overriding the default mechanism is not recommended. Furthermore, note that cursor-based pagination in the Zendesk API typically does not support retrieving more than 100 items for most cursor-based endpoints.

const clientOptions = {
  username: 'your_username',
  token: 'your_token',
  subdomain: 'your_subdomain',
  query: { page: { size: 1 } }
};
const client = zendesk.createClient(clientOptions);