{"id":2384,"date":"2017-12-19T16:44:40","date_gmt":"2017-12-19T16:44:40","guid":{"rendered":"https:\/\/zappysys.com\/blog\/?p=2384"},"modified":"2025-12-20T01:37:50","modified_gmt":"2025-12-20T01:37:50","slug":"configure-zendesk-oauth-application-for-rest-api-call","status":"publish","type":"post","link":"https:\/\/zappysys.com\/blog\/configure-zendesk-oauth-application-for-rest-api-call\/","title":{"rendered":"How to configure Zendesk OAuth Application and Connection for REST API"},"content":{"rendered":"

Introduction<\/h2>\n
UPDATE:<\/strong>\u00a0ZappySys has released a brand new API Connector for Zendesk Online<\/a>, which makes it much simpler to\u00a0Read\/Write Zendesk Data in SSIS<\/strong> compared to the steps listed in this article. You can still use the steps from this article, but if you are new to APIs or want to avoid the learning curve, use a newer approach.<\/p>\n

Please visit\u00a0this page to see all<\/a>\u00a0pre-configured, ready-to-use API connectors\u00a0you can use in\u00a0SSIS API Source<\/a>\/SSIS API Destination<\/a>\u00a0or the\u00a0API ODBC Driver<\/a> (for non-SSIS Apps such as Excel, Power BI, and\u00a0<\/span>Informatica).<\/span><\/p>\n<\/div><\/div>\n

\"\"<\/a>To consume Zendesk data using the REST API, you can use different methods<\/a>. Now, let’s see how to create an OAuth Application so you don’t have to rely on a static Token or a UserID\/Password to access data.<\/p>\n

The OAuth method is more secure and recommended over other methods, so whenever possible, use it.<\/p>\n

<\/h2>\n

Create Zendesk OAuth Application<\/h2>\n

To create an OAuth App for Zendesk, perform the following steps.<\/p>\n

    \n
  1. Log in to your Zendesk Portal. And go tothe\u00a0 following URL (This step assumes you have admin rights to createan\u00a0 OAuth App)\n
    https:\/\/zappysys.zendesk.com\/agent\/admin\/api\/oauth_clients<\/pre>\n
    \"How<\/a>
    How to create a Zendesk OAuth Application for REST API Access<\/p><\/div><\/li>\n
  2. After clicking on the plus sign and entering app information (e.g., Display name, Unique ID, also known as ClientId or AppId )\n
  3. All the way at the bottom of that page, you will see\u00a0Secret (i.e.<\/strong>,\u00a0Client Secret)<\/strong>. Save that along with a unique identifier for later use.<\/li>\n
  4. That’s it. Now you can start using the Zendesk OAuth App to access the REST API<\/li>\n<\/ol>\n
    Understanding Scopes<\/p>\n
    In the next section, you will learn how to configure an OAuth connection. During that, you will need to specify scopes (Token Permissions you want to grant).<\/p>\n
    The syntax to define the scope is as follows. Scope can be read-only<\/strong>, write-only,<\/strong> or read-write. The resource is an optional part. If you omit the scope, it will be applied to all.<\/p>\n
    resource:scope<\/pre>\n
    You can use the following resource scope for the following resources:<\/p>\n
    \n