This endpoint generates an identification token for a website visitor who has been authenticated using your own system. An identification token returned from this API can be used to pass information about your already-authenticated visitor to the chat widget, so that it treats the visitor as a known contact. This allows support agents to recognize and assist the visitor more effectively.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Information used to generate a token
The email of the visitor that you wish to identify
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.
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.
successful operation
The identification token to be passed to the Conversations JS API to identify the visitor
An identification token that allows the visitor to be treated as a known contact.