The Smartsheet connector is a Palantir-provided driver for Smartsheet.
To create a new Smartsheet source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Smartsheet-specific configuration and networking. For the complete property reference, see the official Smartsheet driver documentation ↗.
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
AuthScheme ↗ | Recommended | Specifies the authentication method to use when connecting to Smartsheet. | PersonalAccessToken |
InitiateOAuth ↗ | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | REFRESH |
OAuthClientId ↗ | Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
OAuthClientSecret ↗ | Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
PersonalAccessToken ↗ | Recommended | Specifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface. | — |
Region ↗ | Recommended | Specifies the hosting region for your Smartsheet account. | GLOBAL |
The table below lists the domains that the source needs to be able to access in order to successfully run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead; the agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| api.smartsheet.com | If Region=GLOBAL (default) |
| api.smartsheet.eu | If Region=EU |
| api.smartsheetgov.com | If Region=GOV |
| app.smartsheet.com | Only for Authorization URL, If Region=GLOBAL (default) |
| app.smartsheet.eu | Only for Authorization URL, If Region=EU |
| app.smartsheetgov.com | Only for Authorization URL, If Region=GOV |
The URL field cannot be modified and is fixed as jdbc:smartsheet:. The JDBC properties section can be used as an alternative to modifying the JDBC URL.
For example, to represent the following JDBC URL:
jdbc:smartsheet:InitiateOAuth=GETANDREFRESH;OAuthClientId=MyOAuthClientId;OAuthClientSecret=MyOAuthClientSecret;CallbackURL=http://localhost:33333;, you can specify the additional properties in the JDBC properties section as follows:
