Skip to Content

Zendesk Connector

Summary

The Harmony Zendesk Connector establishes access to Zendesk.

The Zendesk connector provides an interface for creating a Zendesk connection, the foundation used for generating instances of Zendesk activities. These activities, once configured, interact with Zendesk through the connection.

The Zendesk connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Connector Overview

This connector is used to first configure a Zendesk connection. Activity types associated with that connection are then used to create instances of activities that are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

Together, a specific Zendesk connection and its activities are referred to as a Zendesk endpoint:

Zendesk activity types

These activity types are currently supported:

  • Search: Retrieves object data from Zendesk with support for pagination of large datasets, and is intended to be used as a source in an operation.

  • Create: Creates object data in Zendesk and is intended to be used as a target in an operation.

  • Update: Updates object data in Zendesk and is intended to be used as a target in an operation.

  • Delete: Deletes object data from Zendesk and is intended to be used as a target in an operation.

This activity type is deprecated:

  • Query: Retrieves object data from Zendesk returning a limited number of records, and is intended to be used as a source in an operation.

Note

This connector is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Prerequisites and Supported API Versions

The Zendesk connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

The Zendesk connector uses the Zendesk v2 Support API. Refer to the API documentation for information on the schema nodes and fields.

The Zendesk connector supports these objects:

Before creating a connection, you will need to generate a Zendesk API token.

Troubleshooting

If you experience issues with the Zendesk connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging (for Cloud Agents or for Private Agents) to generate additional log files and data.

  4. If using Private Agents, you can enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.zendesk" level="DEBUG"/>
    
  5. If using Private Agents, you can check the agent logs for more information.