How to integrate Zendesk using PowerShell

Learn how to quickly and efficiently connect Zendesk with PowerShell for smooth data access.

Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required. You can do it all using the high-performance Zendesk ODBC Driver (powered by Zendesk Connector for ZappySys API Driver). We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Create data source using Zendesk ODBC Driver

Video instructions

Watch this quick walkthrough to see how to configure your Zendesk ODBC data source, or scroll down for the step-by-step written guide.

Step-by-step instructions

To get data from Zendesk using PowerShell, we first need to create an ODBC data source. We will later read this data in PowerShell. Perform these steps:

1. Download and install ODBC PowerPack (if you haven't already).

2. Search for odbc and open the ODBC Data Sources (64-bit):

   

3. Create a User data source (User DSN) based on the ZappySys API Driver driver:

   ZappySys API Driver

   
   • Create and use a User DSN if the client application runs under a User Account. This is the ideal option at design time (e.g., when developing in Visual Studio). Use it for both types of applications (64-bit and 32-bit).
   • Create and use a System DSN if the client application runs under a System Account (e.g., as a Windows Service). This is usually the required option in a production environment. If your Windows Service is a 32-bit application, you must use the 32-bit ODBC Data Source Administrator to configure this

4. When the Configuration window appears give your data source a name if you haven't done that already, then select "Zendesk" from the list of Popular Connectors. If "Zendesk" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:

   ZendeskDSN

   Zendesk

   

5. Select your authentication scenario below to expand connection configuration steps to:

   • Configure the authentication in Zendesk.
   • Enter those details into the ZappySys API Driver data source configuration.

   Token Authentication

   Zendesk authentication

   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 external API reference

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to Token Authentication [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   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

   

   Find full details in the Zendesk Connector authentication reference.

   OAuth Authentication

   Zendesk authentication

   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 external API reference

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to OAuth Authentication [OAuth]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Press Generate Token button to generate the tokens.
   5. Finally, hit OK button:

   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

   

   Find full details in the Zendesk Connector authentication reference.

   UserID/Password Authentication (2FA must be OFF)

   Zendesk authentication

   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 external API reference

   API Connection Manager configuration

   Just perform these simple steps to finish authentication configuration:

   1. Set Authentication Type to UserID/Password Authentication (2FA must be OFF) [Http]
   2. Optional step. Modify API Base URL if needed (in most cases default will work).
   3. Fill in all the required parameters and set optional parameters if needed.
   4. Finally, hit OK button:

   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

   

   Find full details in the Zendesk Connector authentication reference.

6. Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

   

   ZappySys API Driver - Zendesk

   Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.

   ZendeskDSN

   

7. Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in PowerShell to retrieve data from Zendesk. Hit OK button to use this query in the next step.

   SELECT * FROM Tickets

   
   Some parameters configured in this window will be passed to the Zendesk API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.

8. Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in PowerShell:

   

   ZappySys API Driver - Zendesk

   Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.

   ZendeskDSN

   SELECT * FROM Tickets

   
   You can also access data quickly from the tables dropdown by selecting <Select table>.
   A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Zendesk API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Zendesk servers).

9. Click OK to finish creating the data source.

Read Zendesk data in PowerShell

Sometimes, you need to quickly access and work with your Zendesk data in PowerShell. Whether you need a quick data overview or the complete dataset, this article will guide you through the process. Here are some common scenarios:

• Quickly peek at Zendesk data
• Monitor data constantly in your console

• Export data to a CSV file so that it can be sliced and diced in Excel
• Export data to a JSON file so that it can ingested by other processes
• Export data to an HTML file for user-friendly view and easy sharing
• Create a schedule to make it an automatic process

• Store data internally for analysis or for further ETL processes
• Create a schedule to make it an automatic process

• Integrate data with other systems via external APIs

In this article, we will delve deeper into how to quickly view the data in PowerShell terminal and how to save it to a file. But let's stop talking and get started!

Reading individual fields

1. Open your favorite PowerShell IDE (we are using Visual Studio Code).

2. Use this code snippet to read the data using ZendeskDSN data source:

   "DSN=ZendeskDSN"

   

   For your convenience, here is the whole PowerShell script:

   # Configure connection string and query
   $connectionString = "DSN=ZendeskDSN"
   $query = "SELECT * FROM Customers"
   
   # Instantiate OdbcDataAdapter and DataTable
   $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
   $table = New-Object System.Data.DataTable
   
   # Fill the table with data
   $adapter.Fill($table)
   
   # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
   $format = "{0}`t{1}`t{2}`t{3}"
   
   # Display data in the console
   foreach ($row in $table.Rows)
   {
       # Construct line based on the format and individual Zendesk fields
       $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
       Write-Host $line
   }
   

   Access specific Zendesk table field using this code snippet:

   $field = $row["ColumnName"]

   You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.
   For demonstration purposes we are using sample tables which may not be available in Zendesk.

3. To read values in a console, save the script to a file and then execute this command inside PowerShell terminal:

   
   You can also use even a simpler command inside the terminal, e.g.:

   . 'C:\Users\john\Documents\dsn.ps1'

Retrieving all fields

However, there might be case, when you want to retrieve all columns of a query. Here is how you do it:

"DSN=ZendeskDSN"

Again, for your convenience, here is the whole PowerShell script:

# Configure connection string and query
$connectionString = "DSN=ZendeskDSN"
$query = "SELECT CustomerId, CompanyName, Country, Phone FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Display data in the console
foreach ($row in $table.Rows) {
    $line = ""
    foreach ($column in $table.Columns) {
        $value = $row[$column.ColumnName]

        # Let's handle NULL values
        if ($value -is [DBNull])
        {
            $value = "(NULL)"
        }
        $line += $value + "`t"
    }
    Write-Host $line
}

SELECT * FROM Customers LIMIT 10

Using a full ODBC connection string

In the previous steps we used a very short format of ODBC connection string - a DSN. Yet sometimes you don't want a dependency on an ODBC data source (and an extra step). In those times, you can define a full connection string and skip creating an ODBC data source entirely. Let's see below how to accomplish that in the below steps:

1. Open ODBC data source configuration and click Copy settings:
   

   ZappySys API Driver - Configuration [Version: 2.0.1.10418]

   ZappySys API Driver - Zendesk

   Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.

   ZendeskDSN

   
2. The window opens, telling us the connection string was successfully copied to the clipboard:
3. Then just paste the connection string into your script:
4. You are good to go! The script will execute the same way as using a DSN.

Handling limitations of using a full connection string

Despite using a full ODBC connection string may be very convenient it comes with a limitation: it's length is limited to 1024 symbols (or sometimes more). It usually happens when API provider generates a very long Refresh Token when OAuth is at play. If you are using such a long ODBC connection string, you may get this error:

"Connection string exceeds maximum allowed length of 1024"

But there is a solution to this by storing the full connection string in a file. Follow the steps below to achieve this:

1. Open your ODBC data source.
2. Click Copy settings button to copy a full connection string (see the previous section on how to accomplish that).
3. Then create a new file, let's say, in C:\temp\odbc-connection-string.txt.
4. Continue by pasting the copied connection string into a newly created file and save it.
5. Finally, the last step! Just construct a shorter ODBC connection string using this format:

   DRIVER={ZappySys API Driver};SettingsFile=C:\temp\odbc-connection-string.txt

6. Our troubles are over! Now you should be able to use this connection string in PowerShell with no problems.

Write Zendesk data to a file in PowerShell

Save data to a CSV file

Export data to a CSV file so that it can be sliced and diced in Excel:

# Configure connection string and query
$connectionString = "DSN=ZendeskDSN"
$query = "SELECT * FROM Customers"

# Instantiate OdbcDataAdapter and DataTable
$adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
$table = New-Object System.Data.DataTable

# Fill the table with data
$adapter.Fill($table)

# Export table data to a file
$table | ConvertTo-Csv -NoTypeInformation -Delimiter "`t" | Out-File "C:\Users\john\saved-data.csv" -Force

Save data to a JSON file

Export data to a JSON file so that it can ingested by other processes (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Json | Out-File "C:\Users\john\saved-data.json" -Force

Save data to an HTML file

Export data to an HTML file for user-friendly view and easy sharing (use the above script, but change this part):

# Export table data to a file
$table | ConvertTo-Html | Out-File "C:\Users\john\saved-data.html" -Force

Optional: Centralized data access via ZappySys Data Gateway

In some situations, you may need to provide Zendesk data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

• Centralized data access
  The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
• Centralized access control
  Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in PowerShell (client-side) to connect to it.

Let's not wait and get going!

Create Zendesk data source in the gateway

In this section we will create a data source for Zendesk in the Data Gateway. Let's follow these steps to accomplish that:

1. Search for gateway in the Windows Start Menu and open ZappySys Data Gateway Configuration:

   

2. Go to the Users tab and follow these steps to add a Data Gateway user:

   • Click the Add button
   • In the Login field enter a username, e.g., john
   • Then enter a Password
   • Check the Is Administrator checkbox
   • Click OK to save
   

3. Now we are ready to add a data source:

   • Click the Add button
   • Give the Data source a name (have it handy for later)
   • Then select Native - ZappySys API Driver
   • Finally, click OK
   ZendeskDSN

   ZappySys API Driver

   

4. When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Zendesk ODBC data source created and configured, and follow these steps on how to Import data source configuration into the Gateway:

   • Open ODBC data source configuration and click Copy settings:
     

     ZappySys API Driver - Configuration [Version: 2.0.1.10418]

     ZappySys API Driver - Zendesk

     Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.

     ZendeskDSN

     
   • The window opens, telling us the connection string was successfully copied to the clipboard:

   • Then go to Data Gateway configuration and in data source configuration window click Load settings:

     ZendeskDSN

     

     ZappySys API Driver - Configuration [Version: 2.0.1.10418]

     ZappySys API Driver - Zendesk

     Read and write Zendesk data effortlessly. Manage tickets, users, and organizations — almost no coding required.

     ZendeskDSN

     
   • Once a window opens, just paste the settings by pressing CTRL+V or by clicking right mouse button and then Paste option.

5. Once done, go to the Network Settings tab and Add a firewall rule for inbound traffic:

   
   • This will initially allow all inbound traffic.
   • Click Edit IP filters to restrict access to specific IP addresses or ranges.

6. Crucial Step: After creating or modifying the data source, you must:

   • Click the Save button to persist your changes.
   • Hit Yes when prompted to restart the Data Gateway service.

   This ensures all changes are properly applied:

   
   Skipping this step may cause the new settings to fail, preventing you from connecting to the data source.

Create ODBC data source to connect to the gateway

In this part we will create an ODBC data source to connect to the ZappySys Data Gateway from PowerShell. To achieve that, let's perform these steps:

1. Search for odbc and open the ODBC Data Sources (64-bit):

   

2. Create a User data source (User DSN) based on the ODBC Driver 17 for SQL Server driver:

   ODBC Driver 17 for SQL Server

   
   If you don't see the ODBC Driver 17 for SQL Server driver in the list, choose a similar version.

3. Then set a Name for the data source (e.g. Gateway) and the address of the Data Gateway:

   ZappySysGatewayDSN

   localhost,5000

   
   Make sure you separate the hostname and port with a comma, e.g. localhost,5000.

4. Proceed with the authentication part:

   • Select SQL Server authentication
   • In the Login ID field enter the user name you created in the Data Gateway, e.g., john
   • Set Password to the one you configured in the Data Gateway
   

5. Then set the default database property to ZendeskDSN (the one we used in the Data Gateway):

   ZendeskDSN

   ZendeskDSN

   
   Make sure to type the data source name manually or copy/paste it directly into the field. Using the dropdown might fail because the Trust server certificate option is not enabled yet (next step).

6. Continue by checking the Trust server certificate option:

   

7. Once you do that, test the connection:

   

8. If the connection is successful, everything is good:

   

9. Done!

We are ready to move to the final step. Let's do it!

Access data in PowerShell via the gateway

Finally, we are ready to read data from Zendesk in PowerShell via the Data Gateway. Follow these final steps:

1. Go back to PowerShell.

2. Use this code snippet to read the data using ZappySysGatewayDSN data source:

   "DSN=ZappySysGatewayDSN"

   

   For your convenience, here is the whole PowerShell script:

   # Configure connection string and query
   $connectionString = "DSN=ZappySysGatewayDSN"
   $query = "SELECT * FROM Customers"
   
   # Instantiate OdbcDataAdapter and DataTable
   $adapter = New-Object System.Data.Odbc.OdbcDataAdapter($query, $connectionString)
   $table = New-Object System.Data.DataTable
   
   # Fill the table with data
   $adapter.Fill($table)
   
   # Since we know we will be reading just 4 columns, let's define format for those 4 columns, each separated by a tab
   $format = "{0}`t{1}`t{2}`t{3}"
   
   # Display data in the console
   foreach ($row in $table.Rows)
   {
       # Construct line based on the format and individual Zendesk fields
       $line = $format -f ($row["CustomerId"], $row["CompanyName"], $row["Country"], $row["Phone"])
       Write-Host $line
   }
   

   Access specific Zendesk table field using this code snippet:

   $field = $row["ColumnName"]

   You will find more info on how to manipulate DataTable.Rows property in Microsoft .NET reference.
   For demonstration purposes we are using sample tables which may not be available in Zendesk.

3. Read the data the same way we discussed at the beginning of this article.

4. That's it!

Now you can connect to Zendesk data in PowerShell via the Data Gateway.

Supported Zendesk Connector actions

Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Zendesk operations directly in PowerShell, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:

• Create Organization
• Create Ticket (Single)
• Create Tickets (Bulk)
• Create User
• Delete Attachment
• Delete Organization
• Delete Ticket
• Delete Tickets (Bulk)
• Delete Upload Session
• Delete User
• Read Attachment
• Read Brands
• Read Current User Info
• Read Groups
• Read Macros
• Read Organization Count
• Read Organization Fields
• Read Organization(s) by ID
• Read Organizations (All)
• Read Organizations (Incremental) changed after a specified date
• Read Requests
• Read Requests Search
• Read Sessions
• Read Tags
• Read Ticket ActivityStream
• Read Ticket ActivityStream Details
• Read Ticket Attachments
• Read Ticket Comments
• Read Ticket Events (Incremental) changed after a specified date
• Read Ticket Fields
• Read Ticket Forms
• Read Ticket Metric Events (Incremental) changed after a specified date
• Read Ticket Metrics
• Read Ticket(s) by ID
• Read Tickets (All)
• Read Tickets (Incremental) changed after a specified date
• Read Tickets (Recent)
• Read Tickets Count (All)
• Read Tickets Count (for Organization)
• Read Tickets for Organization
• Read Tickets for User (Assigned)
• Read Tickets for User (CCed)
• Read Tickets for User (Requested)
• Read User Fields
• Read User Sessions
• Read User(s) by ID
• Read Users (All)
• Read Users (Incremental) changed after a specified date
• Read Views
• Search Records - NO Sorting (Allows more than 1000 rows)
• Search Records - WITH Sorting and Extra Columns (Max 1000 rows)
• Update Organization
• Update Ticket (Single)
• Update Tickets (Bulk)
• Update User
• Upload Attachment (Single file)
• Upsert Organization - Create or Update
• Upsert User - Create or Update
• Upsert Users (Bulk) - Create or Update
• Make Generic REST API Request
• Make Generic REST API Request (Bulk Write)

Conclusion

In this article we showed you how to connect to Zendesk in PowerShell and integrate data without writing complex code — all of this was powered by Zendesk ODBC Driver.

Download ODBC PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Explore PowerShell connectors

Amazon Ads

Amazon Athena

Amazon Selling Partner (SP-API)

Apache Derby

Apache Hive

Apache Spark

Asana

Azure DevOps

Cosmos DB

Dropbox

DuckDB (Parquet)

ElasticSearch

FastSpring

Gmail

Google Ads

Google BigQuery

Google Calendar

Google Drive

Google Search Console

Google Sheets

Hubspot

Infor Data Lake

Jira

Mailchimp

ManageEngine ServiceDesk Plus (Zoho)

MariaDB

MySQL

Neo4j

OData

OneDrive

Outlook Mail (Office 365)

Power BI

ServiceNow

SharePoint Online

Shopify

Smartsheet

Starburst

Stripe

Trino

YouTube

Zoho CRM

Zoho SalesIQ

Zoom

REST API

JSON

JSON File

XML

SOAP

XML File

JDBC-ODBC Bridge

Salesforce

CSV

Amazon S3 JSON File

Amazon S3 XML File

Amazon S3 CSV File

Azure Blob JSON File

Azure Blob XML File

Azure Blob CSV File

FTP/SFTP JSON File

FTP/SFTP XML File

FTP/SFTP CSV File

Build your own Custom API Connector

More Zendesk integrations

SSIS

SQL Server

Microsoft Fabric

Power BI

SSRS

Informatica PowerCenter

MS Access

Excel

SSAS

C#

Python

Java

Tableau

SAP Crystal Reports

Azure Data Factory (Pipeline)

Azure Data Factory (SSIS)

Talend Studio

UiPath

Alteryx

ODBC