Zendesk Plug-in

Contents

Overview

This is a sample plug-in with a Kintone integration with "Zendesk", a web based customer service software with an elegant support ticket system, operated by Zendesk, Inc.
https://www.zendesk.com/ (External link)

The Zendesk plug-in works on the record details view. The plug-in will match a key word in your record with a key word in your Zendesk account, and display all tickets related to that key word.
You will need an active Zendesk account to connect your Kintone app with Zendesk.

Integration Screenshots

Setting up the Zendesk Plug-in

Follow the below 4 steps to connect your Kintone app to your Zendesk account.

Step 1: Set up Your Form in the App Settings

To configure your Zendesk plug-in, you will first need to edit your App's form and set the below 2 fields.

  • A “Single-line text” , “Link” or “Record number” field.
    The value inside this field will be used as the key word to fetch Zendesk tickets from your Zendesk account.
    For example, setting this as the "Link" field will enable you to store the email address of your customers, and Zendesk tickets with the same email address can be retrieved and displayed by this plug-in.
  • A Blank space field
    This space will be used to display the Zendesk tickets inside the record details page.
    Make sure to also set up the Element ID of this Blank Space through the field's settings. Give it a unique Element ID of your choice.

Once these fields are set, you can go ahead to place other fields of your choice onto the canvas. They will not affect the behavior of the plug-in.

Step 2: Add the Zendesk Plug-in to Your App

Follow the below procedure to install the Zendesk Plug-in into your Kintone environment, and add it to your app:

  1. Download the Zendesk Plug-in file introduced later on this page
  2. Install the plug-in file into your Kintone environment. Refer to the following article on the Kintone Help site for steps to install the plug-in file:
    Adding plug-ins by importing plug-in files (External link)
  3. Add the Zendesk Plug-in to your app. Refer to the following article on the Kintone Help site for steps to add the plug-in:
    Adding plug-ins to an app (External link)

Step 3: Configure the Settings for the Plug-in

Set up the configurations for the plug-in added to your app in STEP 2.

  1. Click the "Change Settings" cogwheel of the Zendesk plug-in.

  2. Set up each item in the settings as follows:

    • Zendesk Domain Name
      Set the sub-domain name of the Zendesk domain you are using.

    • OAuth Client
      You will need to register Kintone with Zendesk to generate OAuth credentials, which can be done by following the instructions in the following Zendesk link: REGISTERING YOUR APPLICATION WITH ZENDESK (External link) .
      When registering your application, set the redirect URL settings as: https://oauth.cybozu.com/redirect
      Make note of the Unique Identifier and the Secret value that is shown in Zendesk. Once you have finished registering your application with Zendesk, place the Unique Identifier and Secret value into the OAuth Client settings of the Zendesk Plug-in (in Kintone).

    • Fetch Criteria

      • Kintone Field
        Set the field that you set up in Step 1 for this setting. When the value in this "Kintone Field" equals the value in the "Zendesk Ticket Property", related ticket information will show up on the Kintone record.

      • Zendesk Ticket Property
        The Zendesk properties "assignee", "requester", "tags" and custom fields can be set for this field. Select the option you want to match with the "Kintone Field".

    • Filter
      You can set filters here so that a filtered ticket list of your choice will be displayed on Kintone. If no checkboxes are checked, nothing will be filtered, and all tickets will come through.

    • Zendesk Ticket Placeholder on Kintone
      Set the Space field that you set up in Step 1. Ticket information will be displayed on this field. This means you can choose where your Zendesk ticket information will be displayed, by moving around the Blank Space field in the Kintone settings to a place of your choice.
      If no option shows up on the dropdown for this option, check the form settings of your app if there is a Blank Space field with an Element ID set to it.

  3. Click Save.

  4. Click on "Settings" on the breadcrumbs, and on "Apply Changes" to apply the Plug-in settings.

STEP 4: Allow Kintone to Access Zendesk

When you add a new record to the app, a notice will pop up if this is your first time.

Click on the link that appears, and follow Zendesk’s instructions to allow Kintone to access your Zendesk account. Once done, your Zendesk for Kintone app will display tickets related to your "fetch criteria" field, and your app will be ready.

Plug-in Sample

Packaged Sample

SAMPLE_zendesk_v6.0.2.zip (External link)

Updates

Date Update Notes
12th January 2024 Released ver. 6.0.2
  • Fixed homepage_url
15th September 2017 Released ver 6.0.1
  • Fixed a bug where Blank spaces were not retrieved when placed inside Field Groups
12th September 2017 Released ver. 6
  • Total Tickets are now dispalyed
  • Clicking the displayed ticket data will display the latest ticket comments
  • Custom fields are now available as an option for the Filter setting
  • Some UI changes were made
4th September 2015 Released ver. 5

Limitations

  • This Zendesk Plug-in can only be used on the desktop
  • Zendesk tickets will not be displayed while adding or editing records.
  • Fields inside tables cannot be used as the Fetch Criteria.
  • If you have set the record number as the Fetch Criteria, and have also set an App Code for the app (so that record numbers would look like "MYCODE-23" with a string of your choice at the beginning), the whole string (not just the number) will be used to match ticket properties in Zendesk.
  • If custom fields are selected for the Fetch criteria settings, Zendesk will search for all tickets where the Kintone field equals the value of any custom field in Zendesk tickets.
  • Files that are attached to ticket comments will not be displayed.

Notes

  • We do not guarantee this sample to run.
  • We do not provide any technical support for this sample plug-in.
  • This plug-in uses APIs that are not made public on the Kintone Developer Program. Please refrain from developing and selling plug-ins that use these private APIs.

OSS Licenses

The following licenses are being used in this plug-in: