Widget-Installation
Für die Installation des Widgets benötigst du nur ein Snippet. Füge es nahe dem Ende deiner HTML-Seite ein, direkt vor dem schließenden </body>-Tag:
<script>
window.uj ||= new Proxy(
{},
{
get: (_, p) =>
p == 'then'
? 0
: (...a) => {
(window.$ujq ||= []).push([p, ...a]);
}
}
);
uj.init('YOUR_PROJECT_ID');
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>Du findest YOUR_PROJECT_ID unter Einstellungen → Anmelden bei Geheimnisse (oder kannst das vorausgefüllte Snippet auf der Seite Teilen in deinem Dashboard kopieren). Nach dem Laden erscheint der Launcher unten rechts auf deiner Seite.
Der Inline-Snippet richtet einen window.uj-Proxy ein, der Fire-and-Forget-Aufrufe (init, open, close, toggle, identify, logout, setTheme, setLocale, destroy) in eine Warteschlange stellt, bis das SDK vollständig geladen ist, und sie dann erneut ausführt.
Die Reihenfolge der Aufrufe spielt keine Rolle
Du kannst init, identify und open im selben Tick in die Warteschlange stellen, bevor das SDK vollständig geladen ist:
<script>
window.uj ||= new Proxy(
{},
{
get: (_, p) =>
p == 'then'
? 0
: (...a) => {
(window.$ujq ||= []).push([p, ...a]);
}
}
);
uj.init('YOUR_PROJECT_ID');
uj.identify({ user: { id: 'user-123', email: 'user@example.com' } });
</script>
<script type="module" async src="https://cdn.userjot.com/sdk/v3/uj.js"></script>Der Proxy vor dem Laden gibt bei jedem Aufruf undefined zurück. Wenn du Rückgabewerte oder Promises benötigst, etwa bei await uj.identify(...), uj.createEmbed(...), uj.on(...) oder uj.getState(), warte mit dem Aufruf, bis das SDK-Script geladen ist.
Keine Inline-Skripte (strenge CSP)
Wenn deine Website Inline-Scripts blockiert, verwende die Installation mit einem einzelnen Tag und data-project, damit das SDK sich selbst initialisiert:
<script
type="module"
async
src="https://cdn.userjot.com/sdk/v3/uj.js"
data-project="YOUR_PROJECT_ID"
></script>Du kannst Methoden von window.uj weiterhin aus deinem eigenen Bundle aufrufen, sobald das Script geladen ist. Wenn dein Code außerdem uj.init(...) aufruft, hat dein expliziter Aufruf Vorrang vor data-project.
Content-Security-Policy-Direktiven (CSP)
Wenn deine App eine Content Security Policy durchsetzt, erlaube diese UserJot-Ursprünge:
script-src:https://cdn.userjot.comconnect-src:https://widget.userjot.com wss://widget.userjot.com https://collect.jotlens.com(das SDK sendet leichte Widget-Telemetrie-Beacons ancollect.jotlens.comauf nicht lokalen Hosts)img-src:https://media.userjot.com(undhttps://cdn.userjot.comfür hochgeladene Assets)style-srcundfont-src:https://cdn.userjot.com(Schriftarten werden selbst gehostet; eine Freigabe für Google Fonts ist nicht erforderlich)frame-src:https://<your-workspace>.userjot.com(oder deine benutzerdefinierte Domain), wenn du Inline-Einbettungen verwendest
React, Next.js und Single-Page-Anwendungen
Lade
https://cdn.userjot.com/sdk/v3/uj.jseinmal in deinem Root-Layout (zum Beispiel mit<Script strategy="afterInteractive" />in Next.js oder inindex.html). Füge bei Routenwechseln keine doppelten Script-Tags ein.Rufe
uj.init('YOUR_PROJECT_ID', ...)einmal beim Start der App auf unduj.identify(...)/uj.logout(), wenn sich der Authentifizierungsstatus ändert.Räume alle
uj.on(...)-Abonnements undembed.destroy()-Handles in der Bereinigungsfunktion deiner Komponente auf (useEffect-Rückgabewert).
Konfiguration
Übergib Optionen als zweites Argument an init:
uj.init('YOUR_PROJECT_ID', {
widget: {
position: 'right', // 'left' or 'right'
theme: 'auto', // 'auto', 'light', or 'dark'
launcher: true // false hides the default button
},
locale: 'en-US' // optional override
});Alle Optionen sind optional. Setze launcher: false, um das Widget über eine eigene Schaltfläche statt über den Standard-Launcher zu öffnen. Beispiele findest du unter Widget steuern.
Installation überprüfen
Nach dem Laden deiner Seite:
Die Launcher-Schaltfläche erscheint in der konfigurierten Ecke.
Wenn du darauf klickst, wird das Widget geöffnet.
Im Widget kannst du durch Startseite und Feedback (einschließlich Roadmap, wenn aktiviert) navigieren. Außerdem kannst du Updates aufrufen, wenn dein öffentlicher Changelog aktiviert ist.
Wenn das Hilfe-Center verfügbar oder Konversationen aktiviert ist, erscheinen die Tabs Hilfe und Nachrichten automatisch. Dafür sind keine Änderungen am Script erforderlich.
Häufige Probleme
Das Widget wird nicht angezeigt
Vergewissere dich, dass beide Script-Tags vorhanden sind (oder das einzelne Tag mit
data-project).Prüfe, ob
YOUR_PROJECT_IDmit Einstellungen → Anmelden → Geheimnisse übereinstimmt.Prüfe, ob du
widget: falseoderlauncher: falseininitübergeben hast.Prüfe in der Browserkonsole, ob Content-Security-Policy-Fehler
cdn.userjot.comoderwidget.userjot.comblockieren.
Aufrufe scheinen nichts zu bewirken
Wenn uj.open() oder uj.identify(...) nichts bewirkt, vergewissere dich, dass uj.init(...) auf der Seite ausgeführt wurde. Aufrufe, die vor init in die Warteschlange gestellt werden, warten, bis init ausgeführt wird. Wenn Aufrufe ohne init in der Warteschlange verbleiben, gibt das SDK eine Warnung in der Konsole aus.
Nächster Schritt
Verbinde das Widget unter Benutzer identifizieren mit deinen angemeldeten Nutzern.