Skip to main content

Zendesk

Integrating Zendesk with Osano​

Connecting to Zendesk​

In order for Osano to discover data stored in your systems, we must connect to those data providers via an API. We require, at minimum, read-only access to establish a connection to these providers. Each provider you connect may require different information. Please see the linked vendor documentation for instructions on where and how to obtain this data.

Setup​

An admin must create a API Key with the required scopes (read, write) and enter that information in Osano to establish a connection via apiKey.

Authenticated Roles​

admin

Authentication Actions​

  • API Key Email Subdomain -This integration supports Zendesk Support and Guide. Instructions on finding your api Zendesk API Key.

  • Required Scopes

    • read
    • write

Authentication Methods​

  • oauth
  • apiKey

API basic header with the api key and the user's email. Current only support Zendesk Support & Guide. SalesCRM and Chat are not supported due to requiring another API

Core Functionality​

  • Data Discovery
  • User Search
  • Data Deletion

Base URL​

https://$subdomain.zendesk.com/api/v2

  • email
  • name
  • phoneNumber
  • address
  • birthday
  • userId

Endpoints​

Used for data discovery

  • GET users - read
  • GET tickets - read
  • GET help_center/articles/:articleId/comments - read
  • GET community/posts - read
  • GET community/posts/:postId/comments - read

Used for user search

  • GET user/search.json?query=<email> - read
  • GET search.json?query=requester:<userId> - read
  • GET help_center/users/:userId/comments - read
  • GET community/users/:userId/posts - read
  • GET community/users/:userId/comments - read

Used for data deletion

  • DELETE user/:userId - write
  • DELETE tickets/:ticketId - write
  • DELETE help_center/articles/:articleId/comments/:commentId - write
  • DELETE community/posts/:postId - write
  • DELETE community/posts/:postId/comments/:postCommentId - write

Data Deletion​

Currently support summarization and data deletion via the Zendesk GDPR guides - Zendesk Support, Zendesk Guide

Last Modified: 2025-03-26