How to integrate Smartsheet with UiPath
Learn how to quickly and efficiently connect Smartsheet with UiPath for smooth data access.
Read and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required. You can do it all using the high-performance Smartsheet ODBC Driver for UiPath (often referred to as the Smartsheet Connector). 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 Smartsheet ODBC Driver
Step-by-step instructions
To get data from Smartsheet using UiPath, we first need to create an ODBC data source. We will later read this data in UiPath. Perform these steps:
-
Download and install ODBC PowerPack (if you haven't already).
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
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
-
When the Configuration window appears give your data source a name if you haven't done that already, then select "Smartsheet" from the list of Popular Connectors. If "Smartsheet" 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:
SmartsheetDSNSmartsheet
-
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Smartsheet authentication
OAuth Walkthrough
Apps connect to Smartsheet using OAuth 2.0 to authenticate and authorize users. If you are building an app, this documentation will walk you through the steps you need to authenticate your users. The Smartsheet SDKs contain APIs for OAuth 2.0.
NOTE: For users of apps like AWS AppFabric, you will need a Tenant ID. You can find your Tenant ID in Admin Center under Security & Controls. There is a Smartsheet Tenant ID pane.
First Steps
Before you can start using OAuth 2.0 with your app, Smartsheet needs the following information:
- You must register with Smartsheet to get a developer account*. The developer account gives you access to "Developer Tools", which is where you manage your app.
- In "Developer Tools", complete any required fields in your developer profile.
- In "Developer Tools", register your app so Smartsheet can assign a client Id and a client secret to the app.
- Review the list of access scopes. You'll need to choose which ones your app needs to get to a user's Smartsheet data, and then ask the user to consent to that access.
- After you've worked through these steps, you'll be ready to implement the OAuth Flow.
Open Developer Tools
- Log in to Smartsheet with your developer account.
- Click the "Account" button in the lower-left corner of your Smartsheet screen, and then click "Developer Tools".
- Do one of the following:
- If you need to register an app, click "Create New App".
- If you need to manage an app, click "view/edit" for the app.
Register Your App Using Developer Tools
- Log in to Smartsheet with your developer account.
- Click the "Account" button in the upper-right corner of your Smartsheet screen, and then click "Developer Tools".
- In the "Create New App" form, provide the following information:
- Name: the name the user sees to identify your app
- Description: a brief description intended for the user
- URL: the URL to launch your app, or the landing page if not a web app
- Contact/support: support information for the user
- Redirect URL: also known as a callback URL. The URL within your application that will receive the OAuth 2.0 credentials After you click "Save", Smartsheet assigns a client Id and secret to your app. Make a note of these Ids for the next steps; however, you can always look them up again in "Developer Tools".
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
OAuth (Dynamic Token) [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:
SmartsheetDSNSmartsheetOAuth (Dynamic Token) [OAuth]https://api.smartsheet.com/2.0Required Parameters ClientId Fill-in the parameter... ClientSecret Fill-in the parameter... Scope Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 5 RetryMultiplyWaitTime True
Smartsheet authentication
Raw Token Requests
If you want to get started quickly, or are developing a standalone application that can run with your credentials, follow these instructions:
- Click the "Account" button in the lower-left corner of the Smartsheet screen, and then click "Personal Settings".
- Click the "API Access" tab.
- Click the "Generate new access token" button to obtain an access token.
The access token must be sent with every API call in an HTTP authorization header (except for therequests to Get Access Token or Refresh Access Token). Once you have an access token, include it in the Authorization header for every request you make:
Authorization: Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789The header name is Authorization and the value of the header is Bearer JKlMNOpQ12RStUVwxYZAbcde3F5g6hijklM789. Since the access token is being transmitted in clear text, all API calls are done over HTTPS.
NOTE: A best practice is to use a shared account, such as ticket-processor@example.com, rather than your individual work account.
API Connection Manager configuration
Just perform these simple steps to finish authentication configuration:
-
Set Authentication Type to
Static Token [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:
SmartsheetDSNSmartsheetStatic Token [Http]https://api.smartsheet.com/2.0Required Parameters Access Token Fill-in the parameter... Optional Parameters RetryMode RetryWhenStatusCodeMatch RetryStatusCodeList 429|503 RetryCountMax 5 RetryMultiplyWaitTime True
-
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 - SmartsheetRead and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.SmartsheetDSN
-
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 UiPath to retrieve data from Smartsheet. Hit OK button to use this query in the next step.
SELECT * FROM Sheets --Where Id='5815807987847055'
Some parameters configured in this window will be passed to the Smartsheet 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 datamuch faster . -
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 UiPath:
ZappySys API Driver - SmartsheetRead and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.SmartsheetDSNSELECT * FROM Sheets --Where Id='5815807987847055'
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHEREclause,LIMITkeyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Smartsheet 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 Smartsheet servers). -
Click OK to finish creating the data source.
Video Tutorial
Read Smartsheet data in UiPath Studio (workstation)
Here we will be reading Smartsheet data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
-
Open UiPath Studio.
-
Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
SmartsheetDSNSmartsheetDSN
You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration. -
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes! -
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel. -
Once you do that, configure the added Write CSV, this will write Smartsheet data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess" -
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see Smartsheet data:
Optional: Centralized data access via ZappySys Data Gateway
In some situations, you may need to provide Smartsheet 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.
| Data Gateway |
Local ODBC
data source
|
|
|---|---|---|
| Simple configuration | ||
| Installation | Single machine | Per machine |
| Connectivity | Local and remote | Local only |
| Connections limit | Limited by License | Unlimited |
| Central data access | ||
| Central access control | ||
| More flexible cost |
To achieve this, you must first create a data source in the Data Gateway (server-side) and then create an ODBC data source in UiPath (client-side) to connect to it.
Let's not wait and get going!
Create Smartsheet data source in the gateway
In this section we will create a data source for Smartsheet in the Data Gateway. Let's follow these steps to accomplish that:
-
Search for
gatewayin the Windows Start Menu and open ZappySys Data Gateway Configuration:
-
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
-
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
SmartsheetDSNZappySys API Driver
-
When the ZappySys API Driver configuration window opens, go back to ODBC Data Source Administrator where you already have the Smartsheet 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 - SmartsheetRead and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.SmartsheetDSN
-
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:
SmartsheetDSNZappySys API Driver - Configuration [Version: 2.0.1.10418]ZappySys API Driver - SmartsheetRead and write Smartsheet data effortlessly. Integrate, manage, and automate sheets, rows, and reports — almost no coding required.SmartsheetDSN
-
Once a window opens, just paste the settings by pressing
CTRL+Vor by clicking right mouse button and then Paste option.
-
Open ODBC data source configuration and click Copy settings:
-
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.
-
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 UiPath. To achieve that, let's perform these steps:
-
Search for
odbcand open the ODBC Data Sources (64-bit):
-
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. -
Then set a Name for the data source (e.g.
Gateway) and the address of the Data Gateway:ZappySysGatewayDSNlocalhost,5000
Make sure you separate the hostname and port with a comma, e.g.localhost,5000. -
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
-
Then set the default database property to
SmartsheetDSN(the one we used in the Data Gateway):SmartsheetDSNSmartsheetDSN
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). -
Continue by checking the Trust server certificate option:
-
Once you do that, test the connection:
-
If the connection is successful, everything is good:
-
Done!
We are ready to move to the final step. Let's do it!
Access data in UiPath via the gateway
Finally, we are ready to read data from Smartsheet in UiPath via the Data Gateway. Follow these final steps:
-
Go back to UiPath.
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
ZappySysGatewayDSNZappySysGatewayDSN
You can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration. -
Read the data the same way we discussed at the beginning of this article.
-
That's it!
Now you can connect to Smartsheet data in UiPath via the Data Gateway.
john and your password.
Supported Smartsheet Connector actions
Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Smartsheet operations directly in UiPath, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:
- Add Sheet Rows
- Delete Sheet Rows
- Export Report (to PDF, Excel, CSV file)
- Export Sheet (to PDF, Excel, CSV file)
- Get Contacts
- Get Sheet Fields
- Get Sheet Row by ID(s)
- Get Sheet Rows
- List Contacts
- List Groups
- List Reports
- List Sheets
- Search (cell data or other object types)
- Send Report Via Email Excel Pdf Or Pdf Gantt Format
- Send Sheet Via Email Excel Pdf Or Pdf Gantt Format
- Update Sheet Rows
- Make Generic REST API Request
- Make Generic REST API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Smartsheet in UiPath and integrate data without writing complex code — all of this was powered by Smartsheet 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):