> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# HubSpot

export const CommonAuthSchemeOauthEmbedded = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>
        {siteName} provides an embedded OAuth application with which to connect. To use the application, select <strong>OAuth</strong> for <strong>Auth Scheme</strong>. No additional properties are required.
      </p>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        For more information about interactions between {siteName} and {datasource}, see{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a>.
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "HubSpot";
export const pageTitle = "HubSpot";
export const advancedurl = "DH";
export const oauthschemes = "OAuth";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the HubSpot Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to HubSpot

After you add the connector, you need to set the required properties.

{siteName} supports authenticating to {datasource} in a couple of ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**OAuth**](#oauth)
* [**Private App Token**](#private-app-token)

### OAuth

<CommonAuthSchemeOauthEmbedded siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Private App Token

To connect with a private app token, specify the following properties:

* **Auth Scheme:** Select **PrivateAppToken**
* **OAuth Access Token:** Enter the access token that you use to make requests to the resource server.

  To generate a HubSpot private app token:

  1. In your {datasource} account, click the settings icon in the main navigation bar.
  2. Select **Integrations > Private apps** from the menu in the left sidebar.
  3. Click **Create private app**.
  4. On the **Basic Info** tab, configure the details of your application (for example, name, logo, and description).
  5. On the **Scopes** tab, select **Read** or **Write** for each scope that you want your private application to access. This scope determines the data that the driver can access and retrieve. For recommended scopes, see the [OAuthRequiredScopes](https://cdn.cdata.com/help/DHK/jdbc/RSBHubspot_p_OAuthRequiredScopes.htm) and [OAuthOptionalScopes](https://cdn.cdata.com/help/DHK/jdbc/RSBHubspot_p_OAuthOptionalScopes.htm) properties.

  After you configure your application, click **create app** in the top right of the window. Review the information about your application's access token, click **Continue creating**, and then click **Show token**. Copy this token, return to the {siteNameShort} application, and enter the token in the **OAuth Access Token** text box.

## Complete Your Connection

To complete your connection:

1. For **Schema**, select the schema that you want to use:

   * **HubSpot**
   * **HubSpotV3** (default)
   * **HubSpotV4**

   For both **HubSpotV3** and **HubSpotV4**, you can also specify the following optional properties:

   * (Optional) **Expand Associations:** Select whether to expand the object Associations table. By default, the **Enable** checkbox is not selected.
   * (Optional) **Include Custom Tables:** Specify whether you want custom HubSpot objects. By default, the **Enable** checkbox is already selected.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. {oauthschemes ? `If you authenticate with ${oauthschemes}, click` : "Click"} **Connect to {datasource}** to connect to your {pageTitle} account.
4. Click **Create & Test** to create your connection.

## More Information

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />
