Zendesk Connector
Documentation
Version: 9
Documentation

Write data to Zendesk using SSIS (Import data)


In this section we will learn how to configure and use Zendesk Connector in the API Destination to write data to Zendesk.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Zendesk integration in SSIS
  • How to configure connection for Zendesk
  • How to write or lookup data to Zendesk
  • Features about SSIS API Destination
  • Using Zendesk Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Zendesk in the API Source to POST data to the Zendesk.

  1. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

  2. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  3. Select New Connection to create a new connection:

    API Destination - Zendesk
    Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
    API Destination - New Connection

  4. Use a preinstalled Zendesk Connector from Popular Connector List or press Search Online radio button to download Zendesk Connector. Once downloaded simply use it in the configuration:

    Zendesk
    Zendesk Connector Selection

  5. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    Authenticate using Static Token instead of userid / password ([Token Access] option must be enabled under Admin Console > Channel > API > Settings and then Click [ADD API Token] to generate new token. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [API reference]

    Please refer to below API reference (external site) link for Token Authentication [Http]

    https://developer.zendesk.com/rest_api/docs/support/introduction#api-token

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    Token Authentication [Http]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill-in the parameter...
    UserId Fill-in the parameter...
    Token Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

    OAuth App must be created under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/oauth_clients [API reference]

    Please refer to below API reference (external site) link for OAuth Authentication [OAuth]

    https://developer.zendesk.com/rest_api/docs/support/introduction#oauth-access-token

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    OAuth Authentication [OAuth]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill-in the parameter...
    ClientId Fill-in the parameter...
    ClientSecret Fill-in the parameter...
    Permissions Fill-in the parameter...
    RedirectUrl Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN Oauth Connection Configuration

    Authenticate using your userid / password (2FA must be OFF and [Password Access] option must be enabled under Admin Console > Channel > API > Settings. These settings typically found here https://YOUR-SUB-DOMAIN.zendesk.com/agent/admin/api/settings [API reference]

    Please refer to below API reference (external site) link for UserID/Password Authentication (2FA must be OFF) [Http]

    https://developer.zendesk.com/rest_api/docs/support/introduction#basic-authentication.

    Fill in all required parameters and set optional parameters if needed:

    ZendeskDSN
    Zendesk
    UserID/Password Authentication (2FA must be OFF) [Http]
    https://[$Domain$].zendesk.com/api/v2
    Required Parameters
    Sub Domain (e.g. mycompany) Fill-in the parameter...
    UserName (2FA Must be OFF) Fill-in the parameter...
    Password Fill-in the parameter...
    Optional Parameters
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ODBC DSN HTTP Connection Configuration

  6. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Zendesk
    Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
    API Destination - Select Endpoint

  7. Finally, map the desired columns:

    API Destination - Zendesk
    Zendesk Connector can be used to integrate Zendesk REST API in your App / BI Tools. You can read/write data about Tickets, Activity, Users, Organizations and more.
    API Destination - Columns Mapping

  8. That's it; we successfully configured the POST API Call. In a few clicks we configured the Zendesk API call using ZappySys Zendesk Connector

    Execute Package - Reading data from API Source and load into target