HubSpot: Generate visitor token

← Visitor identification operations · Get started

Operation hubspot.visitor_identification_create_visitor_identification

Provider route: POST /visitor-identification/2026-09/tokens/create. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/hubspot with npm, or alter-sdk-hubspot with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HubSpotIntegration } from "@alter-ai/hubspot";

async function execute(input: Parameters<HubSpotIntegration["visitorIdentification"]["createVisitorIdentification"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HubSpotIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.visitorIdentification.createVisitorIdentification(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_hubspot import HubSpotIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HubSpotIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.visitor_identification.create_visitor_identification(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Generate visitor token — request body — body

Referenced models: Generate visitor token — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Generate visitor token — response body

Referenced models: Generate visitor token — response body

Schemas

Generate visitor token — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Required within parent	The email of the visitor that you wish to identify
firstName	string	Optional	The first name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where first name is unknown. Optional.
hsCustomerAgentContext	object	Required within parent	An object containing additional context about the customer agent. This field is required and can include various string properties. Additional keys: see wildcard field
hsCustomerAgentContext.*	string	Additional keys
lastName	string	Optional	The last name of the visitor that you wish to identify. This value will only be set in HubSpot for new contacts and existing contacts where last name is unknown. Optional.

Generate visitor token — response body

Field	Type	Presence	Description and constraints
$	object	Root
token	string	Required within parent	An identification token that allows the visitor to be treated as a known contact.

Policy, approvals and errors

SDK function policy ID: hubspot.visitor_identification_create_visitor_identification. Catalog operation: visitor_identification_create_visitor_identification. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Refused by default. This operation leaves the caller holding a credential (it returns an identification token that signs a chat-widget visitor in as the contact whose email the caller names, so the holder is treated as that contact), so Alter refuses it on every connection with credential_minting_refused unless an organization admin allows it: a credential_minting rule naming provider hubspot and operation hubspot.visitor_identification_create_visitor_identification (or visitor_identification_create_visitor_identification). See Allow an operation that hands over a credential.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["conversations.visitor_identification.tokens.create"]

Official provider source