Zendesk
  • 18 Aug 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Zendesk

  • Dark
    Light

Article summary

Connection

The Zendesk connection is established through SSO with an OAuth2 authorization flow. This process involves using the connecting user's credentials and requires read scopes during the setup:

read
webhooks:write

For a comprehensive list of scopes and a detailed description of the authorization flow, please visit Using OAuth authentication with your application.

Supported Resources

The integration supports the following resources:

  • Tickets

  • Articles (Guides)

  • Organizations

Filtering and Selection

Users can refine the indexing scope of the connected token with options to enable or disable indexing for:

  • Tickets:

    • Index based on tags

    • Index based on groups

  • Articles:

    • Index based on tags

  • Organizations:

    • Enable/Disable indexing

Note: Specific configuration options are not directly available through the Unleash connection interface but can be adjusted behind the scenes. To customize these settings, contact your Unleash representative.

Sync

  • Initial Connection: Upon connecting, the integration retrieves all articles, tickets, and organizations according to the configured filters and selections.

  • Post-Initial Sync: The system updates all resources every 15 minutes based on the initial setup.

  • Real-Time Updates: The Zendesk connection supports webhook registration, enabling the integration to receive updates immediately after changes occur. This functionality reduces the update interval from 15 minutes to nearly real-time. Note that real-time updates and incremental syncs are mutually exclusive and chosen based on system load.

API Calls

The table below details the primary endpoints utilized by the integration:

Endpoint

Docs

Purpose

/api/v2/users/me.json

https://developer.zendesk.com/api-reference/ticketing/users/users/#show-self

Get the connecting user information

/api/v2/organizations.json

https://developer.zendesk.com/api-reference/ticketing/organizations/organizations/#list-organizations

List all organizations

/api/v2/incremental/organizations.json

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-organization-export

Catch up with organizations’ updates

/api/v2/incremental/tickets/.json

https://developer.zendesk.com/api-reference/ticketing/ticket-management/incremental_exports/#incremental-ticket-export-time-based

List all organizations

/api/v2/tickets.json

https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#list-tickets

Catchup with tickets’ updates

/api/v2/deleted_tickets.json

https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#list-deleted-tickets

Catch up with deleted tickets

/api/v2/tickets/{ticket_id}/comments

https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#list-comments

List all comments of a ticket

/api/v2/webhooks

https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#create-or-clone-webhook

Register a webhook for real-time updates

/api/v2/guide/content_tags

https://developer.zendesk.com/api-reference/help_center/help-center-api/content_tags/#search-content-tags

List guide tags

/api/v2/help_center/incremental/articles?start_time={start_time}/api/v2/help_center/articles

https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#list-articles

List all articles


Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.