How to Upload Attachment (Single file) — Zendesk Connector for SSIS
Prerequisites
Before we begin, make sure the following prerequisites are met:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).
Upload Attachment (Single file) in SSIS
-
Begin with opening Visual Studio and Create a New Project.
-
Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.
In the new SSIS project screen you will find the following:
- SSIS ToolBox on left side bar
- Solution Explorer and Property Window on right bar
- Control flow, data flow, event Handlers, Package Explorer in tab windows
- Connection Manager Window in the bottom
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
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 -
Now it's time to configure authentication. Firstly, configure authentication settings in Zendesk service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:
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:
-
Set Authentication Type to
Token Authentication [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ZendeskToken Authentication [Http]https://[$Domain$].zendesk.com/api/v2Required 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 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:
-
Set Authentication Type to
OAuth Authentication [OAuth]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Press Generate Token button to generate the tokens.
- Finally, hit OK button:
ZendeskOAuth Authentication [OAuth]https://[$Domain$].zendesk.com/api/v2Required 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 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:
-
Set Authentication Type to
UserID/Password Authentication (2FA must be OFF) [Http]
- Optional step. Modify API Base URL if needed (in most cases default will work).
- Fill in all the required parameters and set optional parameters if needed.
- Finally, hit OK button:
ZendeskUserID/Password Authentication (2FA must be OFF) [Http]https://[$Domain$].zendesk.com/api/v2Required 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 -
Set Authentication Type to
-
Select Upload Attachment (Single file) endpoint from the dropdown and hit Preview Data:
API Source - ZendeskZendesk 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.ZendeskUpload Attachment (Single file)Required Parameters File Name Fill-in the parameter... File Path (Local) Fill-in the parameter... Optional Parameters Token for exising Upload Session EnableArrayFlattening True -
That's it! We are done! Just in a few clicks we configured the call to Zendesk using Zendesk Connector.
You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)
More actions supported by Zendesk Connector
Learn how to perform other actions directly in SSIS with these how-to guides:
- 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
- Upsert Organization - Create or Update
- Upsert User - Create or Update
- Upsert Users (Bulk) - Create or Update
- Make Generic API Request
- Make Generic API Request (Bulk Write)