The Zendesk connector uses the Zendesk REST API to retrieve tickets and their associated comments and attachments from a Zendesk repository.
Compatible with Fusion version: 4.0.0 through 5.12.0
This connector authenticates to Zendesk using API tokens. Zendesk has announced the end of life for API token authentication in favor of OAuth 2.0 authentication.
Effective April 30, 2027, all remaining Zendesk API tokens will be permanently deactivated, and this connector will no longer operate.Lucidworks is evaluating a V2 connector that supports OAuth 2.0 authentication. Contact your Lucidworks representative to share feedback or express interest.
V1 deprecation and removal noticeAll V1 connectors are deprecated in Fusion 5.18.0 and later. This means they are no longer being actively developed and will be removed in Fusion 6. V1 connectors were also previously deprecated in Fusion 5.12.0 but remained available in all versions between 5.12.0 and 5.18.0, including the Fusion 5.9.x long-term support release line, to support customers on those versions.The replacement for this connector is in active development at this time and will be released at a future date.If you are using this connector, you must migrate to the replacement connector or a supported alternative before upgrading to Fusion 6. Migrate to the replacement connector as soon as possible to avoid any disruption to your workflows.
It retrieves all tickets with all fields (such as customer, assignee, priority, status, and so on) as well as access restrictions for users and groups. ACLs can be used for security trimming at query time.
The types of items retrieved are:
tickets and their associated metrics: for example, time elapsed until first response, time to close.
ticket comment counts, comment IDs
ticket comment attachment URLs
Items retrieved are returned as individual Solr documents, therefore, for a given Zendesk ticket, there will be multiple documents:
the Zendesk ticket itself
one document per comment
one document per comment attachment
Documents have fields for Zendesk type and reference field to parent documents. For example, a comment document will have field ticket_id pointing back to the Zendesk ticket.Incremental recrawls allow updates to the Fusion collection to add new tickets and record further changes to existing tickets without having
to retrieve the entire Zendesk repository contents.
The Zendesk user must have administrator privileges to retrieve all tickets and associated information.
All communication with the Zendesk API is encrypted with SSL.A Zendesk data source must be configured with the following properties:
Authentication Key. The username or email.
Authentication Value. The password or API token.
Token Auth. A flag to indicate whether the auth key/value should be treated as username/password or email/token
Base URL. The API URL to an instance of the Zendesk API
Organization ID. Set to restrict indexing to only tickets that belong to the Organization
It retrieves all tickets with all fields (such as customer, assignee, priority, status, and so on) as well as access restrictions for users and groups. ACLs can be used for security trimming at query time.
The types of items retrieved are:
tickets and their associated metrics: for example, time elapsed until first response, time to close.
ticket comment counts, comment IDs
ticket comment attachment URLs
Items retrieved are returned as individual Solr documents, therefore, for a given Zendesk ticket, there will be multiple documents:
the Zendesk ticket itself
one document per comment
one document per comment attachment
Documents have fields for Zendesk type and reference field to parent documents. For example, a comment document will have field ticket_id pointing back to the Zendesk ticket.Incremental recrawls allow updates to the Fusion collection to add new tickets and record further changes to existing tickets without having
to retrieve the entire Zendesk repository contents.
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
