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.

Required Fields​

  • API Key
  • Email
  • Subdomain

This integration supports Zendesk Support and Guide. Instructions on finding your api Zendesk API Key.

Required Scopes​

  • read
  • write

Core Functionality​

  • Data Discovery
  • User Search
  • Data Deletion

Base URL​

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

Auth​

  • 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

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

Data Deletion​

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

Endpoints​

Used for data discovery

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

Used for user search

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

Used for data deletion

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