Skip to main content
This section shows you how to create a smart collection to list the users of your Zendesk account.

​
Declare the Smart Collection Zendesk Users

Zendesk API allows to access different data: First, we need to declare the smart collection in your project based on the API documentation. As an example, here the smart collection definition for Users: 
const { collection } = require('forest-express-sequelize');

// Search on users => https://support.zendesk.com/hc/en-us/articles/203663216-Searching-users-groups-and-organizations#topic_duj_sbb_vc
collection('zendesk_users', {
  isSearchable: true,
  actions: [],
  fields: [
    {
      field: 'id',
      type: 'String',
      isFilterable: false, // Zendesk API does not provide such capacity with the API
    },
    {
      field: 'name',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'alias',
      type: 'String',
    },
    {
      field: 'email',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'role',
      type: 'Enum',
      enums: ['end-user', 'agent', 'admin'],
      isFilterable: true,
    },
    {
      field: 'role_type',
      type: 'Number',
    },
    {
      field: 'phone',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'whatsapp',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'last_login_at',
      type: 'Date',
    },
    {
      field: 'verified',
      type: 'Boolean',
    },
    {
      field: 'active',
      type: 'Boolean',
    },
    {
      field: 'suspended',
      type: 'Boolean',
      isFilterable: true,
    },
    {
      field: 'created_at',
      type: 'Date',
      isSortable: true,
    },
    {
      field: 'updated_at',
      type: 'Date',
      isSortable: true,
    },
    {
      field: 'last_login_at',
      type: 'Date',
    },
    {
      field: 'notes',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'details',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'tags',
      type: ['String'],
      isFilterable: true, // is it possible? => no arrays are not yet filterable
    },
    {
      field: 'time_zone',
      type: 'String',
    },
    {
      field: 'moderator',
      type: 'Boolean',
    },
    {
      field: 'external_id',
      type: 'String',
      isFilterable: true,
    },
    {
      field: 'only_private_comments',
      type: 'Boolean',
    },
    {
      field: 'photo_url',
      type: 'File',
      get: (user) => {
        return user.photo ? user.photo.content_url : null;
      },
    },
  ],
  segments: [],
});
Some fields are available for filtering or sorting using the Zendesk API. To allow this on the Forest UI, simply add the keywords isFilterable and isSortable in your field definition.

​
Implement the Smart Collection route

In the file routes/zendesk-users.js, we’ve created a new route to implement the API behind the Smart Collection. The logic here is to list all the users of your Zendesk account. 
const express = require('express');
const { PermissionMiddlewareCreator } = require('forest-express-sequelize');

const router = express.Router();
const permissionMiddlewareCreator = new PermissionMiddlewareCreator(
  'zendesk_tickets'
);

const { getUsers } = require('../services/zendesk-users-service');

// Get a list of Zendesk Users
router.get(
  '/zendesk_users',
  permissionMiddlewareCreator.list(),
  (request, response, next) => {
    getUsers(request, response, next);
  }
);

​
Implement the get Route

The section above help you display the list of all Zendesk users. But you’ll need to implement also the logic to display the information of a specific user. We just need to implement a new endpoint to get an individual user from the Zendesk API. 
async function getUser(request, response, next) {
  return axios
    .get(
      `${ZENDESK_URL_PREFIX}/api/v2/users/${request.params.userId}?include=comment_count`,
      {
        headers: {
          Authorization: `Basic ${getToken()}`,
        },
      }
    )
    .then(async (resp) => {
      let record = resp.data.user;
      // Serialize the result using the Forest format
      const recordSerializer = new RecordSerializer({ name: 'zendesk_users' });
      const recordSerialized = await recordSerializer.serialize(record);
      response.send(recordSerialized);
    })
    .catch(next);
}

const { getUsers, getUser } = require('../services/zendesk-tickets-service');

// Get a Zendesk Ticket
router.get(
  '/zendesk_users/:userId',
  permissionMiddlewareCreator.details(),
  (request, response, next) => {
    getUser(request, response, next);
  }
);