Skip to main content

Hubspot authentication

This page documents the authentication and configuration options for the Hubspot agent connector.

Hosted mode (most cases)

In hosted mode, create the connector through the Airbyte Agent CLI or API, then execute operations using the CLI, Python SDK, or API. If you need a step-by-step guide, see the developer quickstart.

OAuth

Use the CLI for hosted OAuth connector creation when possible. It opens the hosted setup flow and avoids passing connector secrets through the command line:

airbyte-agent login
airbyte-agent connectors create --json '{
"workspace": "<your_workspace_name>",
"name": "hubspot"
}'

For API-first use cases, create a connector with OAuth credentials directly.

credentials fields you need:

Field NameTypeRequiredDescription
client_idstrNoYour HubSpot OAuth2 Client ID
client_secretstrNoYour HubSpot OAuth2 Client Secret
refresh_tokenstrYesYour HubSpot OAuth2 Refresh Token
access_tokenstrNoYour HubSpot OAuth2 Access Token (optional if refresh_token is provided)

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"workspace_name": "<WORKSPACE_NAME>",
"connector_type": "Hubspot",
"name": "My Hubspot Connector",
"credentials": {
"client_id": "<Your HubSpot OAuth2 Client ID>",
"client_secret": "<Your HubSpot OAuth2 Client Secret>",
"refresh_token": "<Your HubSpot OAuth2 Refresh Token>",
"access_token": "<Your HubSpot OAuth2 Access Token (optional if refresh_token is provided)>"
}
}'

Token

Create a connector with Token credentials.

credentials fields you need:

Field NameTypeRequiredDescription
private_app_tokenstrYesAccess token from a HubSpot Private App

Example request:

curl -X POST "https://api.airbyte.ai/api/v1/integrations/connectors" \
-H "Authorization: Bearer <YOUR_BEARER_TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"workspace_name": "<WORKSPACE_NAME>",
"connector_type": "Hubspot",
"name": "My Hubspot Connector",
"credentials": {
"private_app_token": "<Access token from a HubSpot Private App>"
}
}'

Execution

After creating the connector, execute operations using the CLI, Python SDK, or API. If your Airbyte client can access multiple organizations, set the default organization with airbyte-agent organizations use, include organization_id in AirbyteAuthConfig, or include X-Organization-Id in raw API calls.

CLI

Authenticate with Airbyte:

airbyte-agent login

Create the connector. The CLI opens the hosted setup flow:

airbyte-agent connectors create --json '{
"workspace": "<your_workspace_name>",
"name": "hubspot"
}'

Describe the connector to see its supported entities and actions:

airbyte-agent connectors describe --json '{
"workspace": "<your_workspace_name>",
"name": "hubspot"
}'

Execute an action:

airbyte-agent connectors execute --json '{
"workspace": "<your_workspace_name>",
"name": "hubspot",
"entity": "<entity>",
"action": "<action>",
"params": {}
}'

Python SDK

The connect() factory returns a fully typed HubspotConnector and reads AIRBYTE_CLIENT_ID / AIRBYTE_CLIENT_SECRET from the environment:

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk import connect
from airbyte_agent_sdk.connectors.hubspot import HubspotConnector

connector = connect("hubspot", workspace_name="<your_workspace_name>")

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@HubspotConnector.tool_utils
async def hubspot_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

Or pass credentials explicitly (equivalent, useful when you're not loading them from the environment): Pydantic AI

Pydantic AI
from pydantic_ai import Agent
from airbyte_agent_sdk.connectors.hubspot import HubspotConnector
from airbyte_agent_sdk.types import AirbyteAuthConfig

connector = HubspotConnector(
auth_config=AirbyteAuthConfig(
workspace_name="<your_workspace_name>",
organization_id="<your_organization_id>", # Optional for multi-org clients
airbyte_client_id="<your-client-id>",
airbyte_client_secret="<your-client-secret>"
)
)

agent = Agent("openai:gpt-4o")

@agent.tool_plain
@HubspotConnector.tool_utils
async def hubspot_execute(entity: str, action: str, params: dict | None = None):
return await connector.execute(entity, action, params or {})

API

curl -X POST 'https://api.airbyte.ai/api/v1/integrations/connectors/<connector_id>/execute' \
-H 'Authorization: Bearer <YOUR_BEARER_TOKEN>' \
-H 'X-Organization-Id: <YOUR_ORGANIZATION_ID>' \
-H 'Content-Type: application/json' \
-d '{"entity": "<entity>", "action": "<action>", "params": {}}'

Open source mode

In open source mode, provide API credentials directly to the connector.

OAuth

credentials fields you need:

Field NameTypeRequiredDescription
client_idstrNoYour HubSpot OAuth2 Client ID
client_secretstrNoYour HubSpot OAuth2 Client Secret
refresh_tokenstrYesYour HubSpot OAuth2 Refresh Token
access_tokenstrNoYour HubSpot OAuth2 Access Token (optional if refresh_token is provided)

Example request:

from airbyte_agent_sdk.connectors.hubspot import HubspotConnector
from airbyte_agent_sdk.connectors.hubspot.models import HubspotOauth2AuthConfig

connector = HubspotConnector(
auth_config=HubspotOauth2AuthConfig(
client_id="<Your HubSpot OAuth2 Client ID>",
client_secret="<Your HubSpot OAuth2 Client Secret>",
refresh_token="<Your HubSpot OAuth2 Refresh Token>",
access_token="<Your HubSpot OAuth2 Access Token (optional if refresh_token is provided)>"
)
)

Token

credentials fields you need:

Field NameTypeRequiredDescription
private_app_tokenstrYesAccess token from a HubSpot Private App

Example request:

from airbyte_agent_sdk.connectors.hubspot import HubspotConnector
from airbyte_agent_sdk.connectors.hubspot.models import HubspotPrivateAppAuthConfig

connector = HubspotConnector(
auth_config=HubspotPrivateAppAuthConfig(
private_app_token="<Access token from a HubSpot Private App>"
)
)