Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubProfessional
Sales HubSales HubProfessional
Service HubService HubProfessional
Content HubContent HubProfessional
Letzte Änderung: 22. August 2025
Verwenden Sie die Besucheridentifikation-API, um Besucher Ihrer Website zu identifizieren, die mit Ihrem eigenen externen Authentifizierungssystem authentifiziert wurden. Ein von dieser API zurückgegebenes Identifikationstoken kann verwendet werden, um Informationen über Ihren bereits authentifizierten Besucher an das Chat-Widget weiterzugeben, sodass es den Besucher als bekannten Kontakt behandelt. Die Mitarbeiter im Postfach können dann sicher sein, mit wem sie sprechen, und die Besucher können geräteübergreifend auf frühere Threads zugreifen. Wenn Sie Ihre eigene Web-App beispielsweise hinter einer Anmeldung hosten, können Sie das HubSpot-Chat-Widget so einrichten, dass es auf Seiten in Ihrer Web-App angezeigt wird, bei denen Sie wissen, dass Besucher bereits authentifiziert und identifiziert sind. Derzeit wird jeder Besucher, der auf diesen Seiten chattet, immer noch als „Unbekannter Besucher“ im Konversationen-Postfach angezeigt, obwohl er ein identifizierter, angemeldeter Besucher in Ihrer Web-App ist. Über die API für die Besucheridentifikation können Sie authentifizierte Besucherinformationen direkt an das Chat-Widget übergeben, über das sie im Konversationen-Postfach identifiziert werden.
Hinweis:
  • Die Besucheridentifikation-API dient dazu, HubSpot mitzuteilen, wer der Besucher ist. Sie sollten sich nicht auf sie verlassen, wenn es darum geht, Benutzer auf Ihrer Plattform zu authentifizieren.
  • Der Zugriff auf die Besucheridentifikation-API erfordert ein Abonnement auf Professional- oder Enterprise-Stufe. Wenn der Account kein qualifiziertes Abonnement hat, erhalten Sie von der API eine 403-Fehlerantwort.

Beispiel für einen Integrationsprozess

Um mit dieser Funktion zu integrieren, müssen Sie über eine vorhandene Webanwendung mit einem Authentifizierungssystem verfügen. Bevor Sie loslegen, stellen Sie sicher, dass Sie eine private App eingerichtet haben und der Account, den Sie zu integrieren versuchen, über ein qualifizierendes Professional- oder Enterprise-Abonnement verfügt. Hier ist ein Beispiel für einen möglichen Integrationsprozess:
Möglicher Benutzeridentifikationsprozess
Sobald Ihr Kunde in Ihrem System angemeldet und verifiziert ist, führen Sie die folgenden Schritte aus, um ihn im Livechat zu identifizieren. 1. Legen Sie in Ihrem Frontend loadImmediately für das Objekt hsConversationsSettings im Fenster auf false fest. Wenn Sie dies nicht tun, kann das Chat-Widget geladen werden, bevor die Identifikationsinformationen weitergegeben werden. Weitere Informationen zur API finden Sie unten im Chat-Widget-SDK-Primer.
  • Legen Sie die Eigenschaften von hsConversationsSettings außerhalb der isConversationsAPIReady-Funktion fest.
  • Außerdem müssen die hsConversationsSettings vor dem Aufruf festgelegt werden, da es sonst zu einer Race Condition kommen kann, die das Laden des Widgets behindert.
window.hsConversationsSettings = {
  loadImmediately: false,
};
2. Generieren Sie ein Token von der API für die Besucheridentifikation, indem Sie die E-Mail-Adresse Ihres authentifizierten Besuchers übergeben. Dies sollte im Backend Ihrer Webanwendung erfolgen. Eine Beispielanfrage finden Sie in der Referenzdokumentation für Endpunkte.
curl --request POST \
  --url 'https://api.hubspot.com/conversations/v3/visitor-identification/tokens/create \
--data '{
  "email": "gob@bluth.com",
  "firstName": "Gob",
  "lastName": "Bluth"
}'
Der angegebene Vor- und Nachname werden in den Kontaktdatensatz in HubSpot festgelegt, nachdem der Chat begonnen hat:
  • Es handelt sich um einen neuen Kontakt, der über die Besucheridentifikation-API erstellt wurde.
  • Es handelt sich um einen bestehenden Kontakt, dessen Name noch nicht bekannt ist.
Dies kann nützlich sein, wenn Nachrichten an identifizierte Besucher personalisiert werden, wenn Ihr externes System bereits über Namensinformationen verfügt, diese jedoch noch nicht in HubSpot vorhanden sind. Hierbei handelt es sich um optionale Parameter, die nicht erforderlich sind.
3. Legen Sie unter Verwendung des Tokens aus Schritt 2 die folgenden Eigenschaften für das hsConversationsSettings-Objekt im Fenster fest.
window.hsConversationsSettings = {
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
4. Laden Sie das Widget.
window.HubSpotConversations.widget.load();
Das Token und die E-Mail müssen jedes Mal, wenn die Seite für einen authentifizierten Besucher geladen wird, auf das hsConversationsSettings-Objekt im Fenster festgelegt werden. Dieser Kontext wird nicht automatisch über Seitenladevorgänge übertragen, wenn diese Parameter nicht mehr festgelegt sind. Token bestehen vorübergehend und laufen nach 12 Stunden ab. Token können, solange sie mindestens alle 12 Stunden aktualisiert werden, zwischengespeichert werden, um zu vermeiden, dass das Token bei jedem Laden der Seite erneut abgerufen wird.

Die Integration verifizieren

Sobald Sie Ihre Integration der Besucheridentifikationsfunktion abgeschlossen haben, können Sie überprüfen, ob sie wie erwartet funktioniert. Dies kann auf zwei Arten geschehen, je nach Ihrer Implementierung, sodass Sie die folgenden Beispiele möglicherweise an Ihre spezifischen Anforderungen anpassen müssen.
  • Wenn Sie das Chat-Widget für eine oder mehrere öffentlichen Seiten sowie hinter einem Authentifizierungssystem hinzugefügt haben:
    • Gehen Sie zu einer Seite, auf der das Chat-Widget keine Besucher identifiziert und eine Konversation startet.
    • Öffnen Sie in HubSpot das Postfach und verifizieren Sie, dass der gerade eingegangene Chat in die Kategorie Unbekannter Besucher fällt. Wenn dies nicht der Fall ist, versuchen Sie, diese Schritte in einem privaten Browserfenster durchzuführen.
      • Gehen Sie zu einer Seite, auf der das Chat-Widget Besucher über die API für die Besucheridentifikation identifiziert und eine Konversation startet.
      • Öffnen Sie in HubSpot das Postfach und verifizieren Sie, dass der Chat korrekt dem Kontakt zugeordnet ist, unter dem Sie angemeldet sind. Sie sollten neben dem Namen des Kontakts ein Abzeichen sehen, das angibt, dass dieser Kontakt über diese API erfolgreich identifiziert wurde.
visitor_identity_badge
  • Wenn Sie das Chat-Widget nur für Seiten hinter einem Authentifizierungssystem hinzugefügt haben und Zugriff auf mehrere Testbenutzer-Accounts haben:
    • Melden Sie sich als erster Testbenutzer bei HubSpot an, gehen Sie dann zu einer Seite, auf der das Chat-Widget geladen wird, und starten Sie eine Konversation.
    • Melden Sie sich von HubSpot ab und als zweiter Testbenutzer wieder an. Gehen Sie zu einer Seite, auf der das Chat-Widget geladen wird, und beginnen Sie eine Konversation.
    • Öfnnen Sie dann in HubSpot das Postfach und verifizieren Sie, ob die eingegangenen Chats vom ersten bzw. zweitenTest-Account stammen und ob Sie das Abzeichen neben den Kontaktnamen für beide Datensätze sehen.
Hinweis: Für Besucher, die mit dieser API identifiziert werden, setzt HubSpot nicht das messagesUtk-Cookie. HubSpot überspringt auch alle Fragen zur E-Mail-Erfassung, da die E-Mail-Adresse bereits bekannt ist. Da das messagesUtk-Cookie und die E-Mail-Erfassung nicht bei diesen Chats angewendet werden, werden die zugehörigen Einstellungen im Chatflow für Besucher, die über die Besucheridentifikation-API identifiziert wurden, nicht angezeigt.

Chat-Widget SDK-Primer

Die API ist im window.HubSpotConversations-Objekt untergebracht. Es können alle verfügbaren Methoden über dieses Objekt aufgerufen werden. Der HubSpot-Skriptlader auf Ihrer Seite erstellt dieses Objekt für Sie, aber es ist möglicherweise nicht sofort verfügbar. Um den Zugriff auf die API aufzuschieben, bis sie initialisiert ist, können Sie sich mit window.hsConversationsOnReady behelfen. Zum Beispiel:
<script type="text/javascript">
  function onConversationsAPIReady() {
    console.log(`HubSpot Conversations API: ${window.HubSpotConversations}`);
  }
  /*
    configure window.hsConversationsSettings if needed.
  */
  window.hsConversationsSettings = {};
  /*
   If external API methods are already available, use them.
  */
  if (window.HubSpotConversations) {
    onConversationsAPIReady();
  } else {
    /*
      Otherwise, callbacks can be added to the hsConversationsOnReady on the window object.
      These callbacks will be called once the external API has been initialized.
    */
    window.hsConversationsOnReady = [onConversationsAPIReady];
  }
</script>

SDK-Referenz

window.hsConversationsOnReady-Array Dies ist ein optionales Feld, das Sie für das Fensterobjekt definieren können und das es Ihnen ermöglicht, Code anzugeben, der ausgeführt wird, sobald das Widget verfügbar ist. Sobald die API initialisiert wurde, überprüft sie auf das Vorhandensein dieses Arrays und führt seine Funktionen der Treihe nach aus.
if (window.HubSpotConversations) {
  console.log('The api is ready already');
} else {
  window.hsConversationsOnReady = [
    () => {
      console.log('Now the api is ready');
    },
  ];
}
hsConversationsSettings-Objekt Dieses Objekt ermöglicht es Ihnen, vor dem Initialisieren einige Konfigurationsoptionen für das Widget anzugeben. Um die Besucheridentifikationsfunktion verwenden zu können, müssen Sie die folgenden Felder festlegen:
ParameterTypBeschreibungStandard
loadImmediatelyBooleschOb das Widget implizit geladen werden soll oder ob gewartet werden soll, bis die widget.load-Methode aufgerufen wirdtrue
identificationTokenZeichenfolgeWird zur Integration mit der Besucheridentifikation-API verwendet. Dies ist das Token, das vom Endpunkt der Token-Generierung in der Besucheridentifikation-API bereitgestellt wird und als Nachweis dafür dient, dass dieser Besucher identifiziert wurde.""
identificationEmailZeichenfolgeDie E-Mail-Adresse des Besuchers, den Sie als Benutzer identifiziert haben, der das Widget lädt.""
window.hsConversationsSettings = {
  loadImmediately: false,
  identificationEmail: 'visitor-email@example.com',
  identificationToken: '<TOKEN FROM STEP 1>',
};
Erfahren Sie mehr über das Konversationen SDK.