HubSpot

Visitor Identification

The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by…

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by your own authentication system.

Endpoints 1

Generate

  • POSTGenerate a token/conversations/v3/visitor-identification/tokens/createGenerates a new visitor identification token. This token will be unique every time this endpoint is called, even if called with the same email address. This…

API details

Base URL
https://api.hubapi.com
Authentication
An API key in the hapikey query parameter
OAuth 2.0 (authorization code flow) with 1 scope
An API key in the private-app-legacy header
Operations
1 operation on 1 pathPOST 1
Main resources
Generate 1
Response formats
application/json
Description format
OpenAPI 3.0.1, API version v3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Visitor Identification in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Visitor Identification collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the hapikey query parameter. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Generate a token” (POST /conversations/v3/visitor-identification/tokens/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Visitor Identification?

The Visitor Identification API allows you to pass identification information to the HubSpot chat widget for otherwise unknown visitors that were verified by… It is listed under Other and has 1 endpoint.

Who publishes the Visitor Identification?

It is listed from HubSpot's public API description (an OpenAPI document), not published by HubSpot on Swastik Codes. Anyone who controls hubapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Visitor Identification?

Requests go to https://api.hubapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the Visitor Identification?

It accepts 3 methods: an API key in the hapikey query parameter; OAuth 2.0 (authorization code flow) with 1 scope; an API key in the private-app-legacy header.

How many endpoints does the Visitor Identification have?

1 operation on 1 path (1 POST). The largest groups are Generate.

Is forking the Visitor Identification free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.