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

# HubDB

export const title_1 = "HubDB";

export const title_0 = "HubDB";

## Prerequisites

The **OAuth** authentication method requires a custom OAuth application created in HubSpot. If you are connecting with the **PrivateApp** method, you can skip this section.

To create a custom OAuth application, follow these steps:

<Steps>
  <Step>
    Sign in to your HubSpot developer account. If you do not have one, create a developer account at [developers.hubspot.com](https://developers.hubspot.com/).
  </Step>

  <Step>
    Navigate to **Apps** and click **Create app**.
  </Step>

  <Step>
    On the **Auth** tab, record the **Client ID** and **Client secret**. You enter these values as the **OAuth Client Id** and **OAuth Client Secret** in the setup steps below.
  </Step>

  <Step>
    In the **Redirect URLs** field, enter the Connect AI callback URL `https://oauth.cdata.com/oauth/`.
  </Step>

  <Step>
    Under **Scopes**, add the scopes your application needs to access HubDB data, then save your application.
  </Step>
</Steps>

## Setup Guide

Follow these steps to connect HubDB to your Connect AI account:

<Steps>
  <Step>
    Open the **Sources** page of the Connect AI navigation menu.
  </Step>

  <Step>
    Click **+ Add Connection** in the upper-right corner.
  </Step>

  <Step>
    Type *HubDB* into the search field, then click the data source name.
  </Step>

  <Step>
    On the **Basic Settings** tab of the new connection, enter a connection name or keep the default name.
  </Step>

  <Step>
    Select your **Auth Scheme** and follow the instructions in the relevant section below.
  </Step>
</Steps>

## Authentication Methods

<Tabs>
  <Tab title="OAuth">
    <Steps>
      <Step>
        Enter the following information:

        * **OAuth Client Id**—Set to the client ID (also known as the consumer key) assigned to your custom OAuth application.
        * **OAuth Client Secret**—Set to the client secret assigned to your custom OAuth application.
      </Step>

      <Step>
        Click **Sign in** to connect securely through OAuth. This action opens the HubDB sign-in page in a new tab.
      </Step>

      <Step>
        Log in to your HubSpot account and provide the requested permissions (if applicable).
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_0} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>

  <Tab title="PrivateApp">
    Enter your HubSpot Private App Token in the **Private App Token** field.

    You can generate a HubSpot Private App Token by following the steps below.

    <Steps>
      <Step>
        In your HubSpot account, click the **Settings** icon in the main navigation bar.
      </Step>

      <Step>
        In the left sidebar menu, navigate to **Integrations > Private Apps**.
      </Step>

      <Step>
        Click **Create private app**.
      </Step>

      <Step>
        On the **Basic Info** tab, configure the details of your application (name, logo, and description).
      </Step>

      <Step>
        On the **Scopes** tab, select **Read** or **Write** for each scope you want your private application to be able to access. This determines the data the connector has access to retrieve.
      </Step>

      <Step>
        After you are done configuring your application, click **Create app** in the top right. Review the information about your application's access token, click **Continue creating**, and then **Show token**.
      </Step>

      <Step>
        At the top of the Connect AI **Add {title_1} Connection** page, click **Save & Test**.

        * If the connection test succeeds, a **Connection successfully saved** message appears, indicating that your connection has been created. The **Status** on the **Edit Connection** page also changes to **Authenticated**. View the data model of your successful connection in the right pane of the **Edit Connection** page, in the **Data Model** tab.
        * If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. Connect AI displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the **Sign in** button. Correct the errors and try again.
        * Unsuccessful connections are saved as drafts and have a **Status** of **Not Authenticated**. You can return to the connection and authenticate it later.
      </Step>
    </Steps>
  </Tab>
</Tabs>