Zendesk Chat:

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 Chat OAuth token:

1. Access Zendesk Chat directly or through the “Chat” option located in the top right corner of the Zendesk product.
2. Navigate to “Settings” > “Account” > “API” > “Add API client”.
3. Fill in the client name, company, and redirect URLs (default: http://localhost:8080).
4. Record the “CLIENT_ID” and “SUBDOMAIN”.
5. Format the following URL with your own CLIENT_ID and SUBDOMAIN, paste it into a new browser tab, and press Enter.
6. The call will be made, possibly prompting you to log in and select ‘Allow’ to generate the token.
7. If the call is successful, your browser’s address field will display your new OAuth token (returned as the access_token value).
8. Despite any error messages in the browser’s main window, if ‘access_token’ appears in the browser’s URL field, then the process was successful.
9. Safely store the OAuth token for authentication purposes when retrieving data from Zendesk Chat.
10. Additional methods for obtaining a Zendesk chat token can be found in the full documentation provided here.

Connection Properties:

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

Connectorname: Zendesk
subdomain: Zendesk sub-domain
Oauth_token: OAuth token

Metadata Properties:

This section defines the mode of data refresh. There are two modes: INCREMENTAL and FULL_TABLE. It only supports columns with DateTime data types.

metadata:
  TableName:
    replication_method: INCREMENTAL
    replication_key: Column name
    replication_value: column value that data starts from

  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

Examples:

INCREMENTAL:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: <SUBDOMAIN>
        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'

FULL_TABLE:

version: 1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: <SUBDOMAIN>
        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

Configure the Data Hub to connect Zendesk Chat

1. To start, Click the Bold Data Hub icon on the Navigation Pane.

2. Click Add Pipeline and provide the name for the new pipeline.

3. Select the newly created pipeline and add the Zendesk Chat template.

4. Update the subdomain and OAuth token in the template. Also, Update the resources on the select property and save it to the BoldBI Data Store.

5. Creating a Pipeline in Bold Data Hub automatically creates a Data Source in Bold BI. The Bold BI Data Source is a live data source to the destination database used in Bold Data Hub. For more information on the relationship between Bold Data Hub Pipeline and the associated Data Sources in Bold BI , please refer to Relationship between Bold Data Hub Pipeline and Associated Data Sources in Bold BI

Warning:

1. The `Encrypt_Credentials` property should be set to false when updating the new access token on the template. If you have modified other properties, such as 'select' or 'account id', the `Encrypt_Credentials` property must be set to true.  
2. The default lifetime of the access token is 1 hour. Therefore, you need to convert it to a long-lived access token in order to use the same token for 60 days. Existing tables should be maintained even if the token has expired or is being used as an invalid token. 

Schedule Data Hub Job

1. To configure interval-based scheduling, click on the schedules tab and select the created pipeline and click on the schedule icon and configure it.

2. For on-demand refresh, click Run Now button.

.

3. The Schedule history can be checked using the history option as well as logs.

4. Click on Logs to see if the run is completed and data source is created in Bold BI.

5. Click Edit DataSource Option to view the created tables.