Enterprise
Schedule Free DemoSupportBlogDemos
Try it Free
Search results
Suggest a FeaturePDF

Zendesk Support

Zendesk is a cloud-based customer service and support platform, offering features such as ticket management, self-service options, knowledge base management, live chat, customer analytics, and talks.

Zendesk support can be authenticated using one of the following three methods:

  1. Method 1 (subdomain + email address + password)
  2. Method 2 (subdomain + email address + API token)
  3. Method 3 (subdomain + OAuth token)

Grab Subdomain

Log into Zendesk to find your subdomain in the URL. For example, for www.yourhub.zendesk.com, the subdomain is yourhub.

Grab Zendesk Support API Token

  1. In Zendesk (top right), select Admin Center.
  2. Choose “Apps and Integrations.”
  3. Navigate to APIs and select Zendesk API. Activate “Password access” & “Token access”.
  4. Click “Add API token,” add a description, and note down the API token.
  5. The token displays just once; note it safely.

Grab Zendesk Support OAuth Token

  1. Obtain client ID via Zendesk API: Send this curl request and note the response’s client ID.
  2. Alternatively, fetch client ID via OAuth using this.
  3. To get a full token using the client id obtained above, follow the instructions here.
  4. In response to the above request, you’ll get a full token that can be used to configure Zendesk support.

Connection Properties

In the yaml file, the config section contains the following properties:

Connector Name: Zendesk
Subdomain: Zendesk sub-domain
Email: Mail id used for login
Password: Password for the account
Token: API Token
OAuth Token: OAuth token

Metadata Properties

In this section, the mode of data refresh is defined. There are two modes: INCREMENTAL and FULL_TABLE. It only supports Date/DateTime datatype columns.

INCREMENTAL 
metadata:
  TableName:
    replication_method: INCREMENTAL
    replication_key: Column name
    replication_value: column value that data starts from
 This mode will fetch data from date column mentioned replication key from the start date as mentioned in replication_value. Once it is Scheduled, replication_value updated automatically from the imported data.
FULL_TABLE 
  metadata:
  TableName:
    replication_method: FULL_TABLE
    replication_key: Column name
    replication_value: column value that data starts from
    interval_type: days/hours/minutes/year/month
    interval_value: integer value to add in interval type
This mode retrieves data from the specified date column in the replication key, starting from the date specified in the replication value. Once scheduled, the replication value is updated based on the interval_type and interval_value from the imported data. For instance, if the interval_type is 'year' and the interval_value is '1', the initial schedule will fetch records from January 1, 2000 to December 31, 2000. In the subsequent schedule, it will fetch records from January 1, 2001 to December 31, 2001, and so forth.

Example

FULL_TABLE

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: <SUBDOMAIN>
        email: <EMAIL>
        password: <PASSWORD>
        token: <TOKEN>
        Oauth token: <OAUTH TOKEN>
    Select:
      - TABLE1
      - TABLE2
    metadata:
      TABLE1:
        replication_method: FULL_TABLE
        replication_key: last_modified_on
        replication_value: '2023-07-19 00:00:00'
        interval_type: days
        interval_value: 6
      TABLE2:
        replication_method: FULL_TABLE
        replication_key: last_modified_on
        replication_value: '2023-07-19 00:00:00'
        interval_type: days
        interval_value: 6

INCREMENTAL

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: <SUBDOMAIN>
        email: <EMAIL>
        password: <PASSWORD>
        token: <TOKEN>
        Oauth token: <OAUTH TOKEN>
    Select:
      - TABLE1
      - TABLE2
    metadata:
      TABLE1:
        replication_method: FULL_TABLE
        replication_key: last_modified_on
        replication_value: '2023-07-19 00:00:00'
      TABLE2:
        replication_method: FULL_TABLE
        replication_key: last_modified_on
        replication_value: '2023-07-19 00:00:00'