RDBMS

Zendesk

A Zendesk connector is an integration tool that connects Zendesk, a customer service platform, with other systems or applications.

OvalEdge enables connectivity to Zendesk using the Rest API, allowing for tasks such as crawling database objects, profiling sample data, and building relationships.

Note: This connector document should be used along with the Generic Features of Connectors document, which covers the generic features and settings (Establishing Connection, Connector Parameters, Connector Settings, etc.) of the OvalEdge connectors that are common. This document only outlines the specific connector information.

Connector Characteristics

Connector Category

RDBMS

Connectivity

API

Connector Version

6.3.1

Zendesk Versions Supported 

8 onwards

OvalEdge Releases Supported (Available from)

5.0 onwards

Supported Features

Crawling of Metadata Objects 

Schemas, Tables, Table Columns, and Relationships

Metadata Source

Zendesk Commands

E.g.: 

sys.db_users (schemas)
All_tab_comments (Tables)
ALL_TAB_COLUMNS (Columns)

Profiling

Table Profiling: Row Count, Column Count, View Sample data

Column Profiling: Min, Max, Null Count, Distinct, Top 50 values

Sample Profiling: Supported

Crawling of Query Logs

Supported

Data Preview

Supported

Data Lineage

Not Supported

Data Quality Module

Not Supported

RDAM (Remote Data Access Management) Support

Not Supported

Bridge Support

Supported

Query Sheet Support (Run simple queries)

Not Supported

Crawl of Usage Statistics (Source System)

Not Supported

Certifications at Source (Source System)

Not Supported

Prerequisites (Prepare Zendesk Environment)

The following are the prerequisites required for establishing a connection: 

  • Driver Details

Driver/API

Version

Details

API

   

  • Zendesk connector Account and Permissions

Operation 

Access Permission 

   
   
   
   

  • Configure Environment Variables (Optional)

This section describes the settings or instructions you should know before establishing a connection. If your environments have been configured, skip this step.

For more information, refer to the "Generic Features of Connectors" document.

Zendesk Specific Parameters

Fields

Details

Server*

The server is the endpoint or host the connector uses to connect to Zendesk.

Example: https://your_subdomain.zendesk.com/api/v2 

Schema Crawl*

Users can select either Ticket API or Chat API. 

Ticket API refers to an API endpoint or process used to extract or interact with the ticket data schema within Zendesk.

Chat API refers to an API or method for automatically exploring and retrieving metadata about a database or application's schema.

Username*

Enter your Zendesk connector username for authentication.

Example: your_email@example.com

Password*

A password is required to connect to the Zendesk server.

Connector Settings

The following are the Zendesk Connector settings:

  • Crawler
  • Profiler
  • Access Instruction
  • Business Glossary Settings
  • Anomaly Detection Settings
  • Others

Errors & Resolution

S.No.

Error Message(s)

Error Description/Resolution

1

API Rate Limit Exceeded 

Error Description: The connector has exceeded the API rate limit set by Zendesk.

Resolution:

  • Review the rate limit settings and ensure the connector is not making excessive API calls.
  • Implement request throttling or caching mechanisms to reduce the number of API calls.
  • Consider optimizing the data retrieval logic to minimize the number of requests.

2

Rate Limiting or Quota Exceeded

Error Description: The connector may be making too many requests in a short period.

Resolution:

  • Implement rate limiting or retry mechanisms in the integration.
  • Review the database server's rate limits and quotas and adjust accordingly.

FAQs

Q1: How much does the driver cost?

A: The JDBC Driver for Zendesk is available at no additional charge.

Q2: Can I use the driver to access Zendesk from a Linux system?

A: Yes! You can use the driver to access Zendesk from Linux, Unix, and other non-Windows platforms.