• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    Data connectivity & integrationAvailable connectorsSmartsheet

    Smartsheet

    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 ↗.

    Supported capabilities

    CapabilityStatus
    Exploration🟢 Generally available
    Batch syncs🟢 Generally available
    Incremental🟢 Generally available
    OAuth 2.0 authentication🟢 Generally available
    Table exports🟢 Generally available

    Configuration

    The properties below are mandatory or recommended.

    PropertyRequired?DescriptionDefault
    UseLegacyAPI ↗MandatoryDetermines what API to use for discovering table metadata (and some columns metadata as well).FALSE
    AuthScheme ↗RecommendedSpecifies the authentication method to use when connecting to Smartsheet.PersonalAccessToken
    InitiateOAuth ↗RecommendedSpecifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working.REFRESH
    OAuthClientId ↗RecommendedSpecifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.—
    OAuthClientSecret ↗RecommendedSpecifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.)—
    PersonalAccessToken ↗RecommendedSpecifies the Personal Access Token for authenticating with Smartsheet. This token can be generated through the Smartsheet user interface.—
    Region ↗RecommendedSpecifies the hosting region for your Smartsheet account.GLOBAL

    Networking

    The table below lists the domains that the source must be able to access to 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.

    DomainRequired
    api.smartsheet.comIf Region=GLOBAL (default)
    api.smartsheet.euIf Region=EU
    api.smartsheetgov.comIf Region=GOV
    app.smartsheet.comOnly for Authorization URL, If Region=GLOBAL (default)
    app.smartsheet.euOnly for Authorization URL, If Region=EU
    app.smartsheetgov.comOnly for Authorization URL, If Region=GOV

    OAuth 2.0 authentication

    This connector supports OAuth 2.0 authentication. Follow the OAuth 2.0 guidance for Palantir-provided drivers to configure and authorize the connection.

    Table exports

    This connector supports table exports. Learn how to set up a table export.

    Connection settings

    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:

    Smartsheet connection settings.