Skip to main content

Go-Live Checklist

This guide walks you through everything needed to bring a finished, tested LoyJoy chat agent live on your website: a clean technical setup, the legal essentials, and the settings that make sure the chat actually gets discovered and used. The legal notes are not legal advice; have your Data Protection Officer review the final setup.

1. Publish your changes​

Nothing becomes visible until you publish the current version of your agent. Click the publish button in the Manager and optionally add a comment to track changes. Due to caching, it takes a few minutes (typically ~2) for the published version to be served. A version history is available on the Enterprise and Unlimited plans. See Publish Your Agent.

2. Test before go-live​

Share and test the agent before the public launch. The Publish tab offers several ways to securely test the agent with colleagues and gather feedback, so configuration issues never reach your customers.

3. Embed the JavaScript snippet​

The technical integration is a single line of JavaScript. The snippet is on the Publish tab of your agent and carries a unique process ID:

<script async defer src="https://stable.loyjoy.com/widget.js?process=YOUR-PROCESS-ID"></script>

Three things matter. LoyJoy does not affect page load time, because async and defer make the script run only after the page has loaded, avoiding render-blocking. Place the LoyJoy snippet after your consent manager's snippet in the HTML so LoyJoy can read the consent status while loading. Many behaviors are controlled by settings in the Manager, which adapt the snippet automatically.

By default the chat appears as an overlay. To embed it inline, add a div with the id loyjoy-chat and enable the Intersection Observer (Branding tab, "Conversation" area) so the chat starts only when visible. You can also open, close, hide, and show the chat from your own button via the JavaScript API. To host the chat on your own domain, follow the guide for your own website.

4. Cookie banner / consent manager: two paths​

Once a cookie banner runs on your site, there are two fundamental ways for LoyJoy loading and consent to interact. Choose one of them.

Path 1 — The cookie banner controls loading (manual administration). You manage the consent manager yourself: add LoyJoy as a service, store a description text, and assign a category. The consent manager then decides whether the LoyJoy snippet is allowed to load at all. Recommendation: classify LoyJoy as "Essential / Technically Necessary" so the chat loads immediately and the bubble is visible. If you classify LoyJoy as "Marketing" instead, the chat only appears after the user clicks "Accept" — this costs reach. The Trust Center provides the description text (template below).

Path 2 — LoyJoy controls consent (the shortcut). You skip administering the cookie banner and instead select your consent manager in the LoyJoy settings. Supported: Borlabs Cookie, CCM19, Cookiebot, ConsentManager, CookieFirst, OneTrust, Sourcepoint, Tealium, Usercentrics, Atruvia, OneConsent. If yours is missing, email support@loyjoy.com and we add it for free. LoyJoy then decides how it behaves toward the user's choice, via one of two modes:

  • Basic mode: LoyJoy adapts its snippet to the consent manager. You give LoyJoy a cookie category, and the chat loads only after the banner is closed. Drawback: classified as marketing the chat does not appear if the user rejects; classified as essential the instant loading may collide with the banner window.
  • Smart mode (recommended): LoyJoy always shows the chat, but waits for the banner to close and enables storage (Local Storage) only if the user consented to all categories. On rejection the chat still runs, just without persistent storage (history is lost on reload). The benefit: you do not need to classify LoyJoy as essential, functional, or marketing, because the chat respects the choice on its own.

A technical caveat for Path 2: Some consent managers block unknown scripts by default. In that case the LoyJoy snippet still has to be allowed to load once (typically marked "Essential"), otherwise Smart mode cannot take effect either. Important: do not rewrite the script tag to type="text/plain", or the chat will not appear for new users. For the full classification rationale and pitfalls, see Cookie Banner Configuration.

The administrator creates this entry. Use this template (adapt per customer, e.g. storage duration):

  • Recommended category: Essential / Technically Necessary
  • Service name: LoyJoy Chat Assistant
  • Provider: LoyJoy GmbH, Münster, Germany
  • Purpose: Provides an interactive chat service (AI Agent). Storage is technically required to maintain chat history and conversation context across page views.
  • Storage type: Local Storage; no classic tracking cookies.

5. Configure chat history and variable storage​

On the Publish tab, decide whether chat history and variables are stored. When active, they are stored only client-side in the browser's loyjoy-chat local storage object, never on a server. Storage duration is selectable: off, 30 minutes, 24 hours, 7 days, or 14 days. With history off, a fresh chat starts on every page load. This setting determines whether anything is stored in the browser at all.

6. Update your privacy policy​

LoyJoy processes end-user data as a processor under Art. 28 GDPR on behalf of the customer, who is the controller and must add LoyJoy to their own privacy policy. The Trust Center provides ready-to-use text variants for chat agent only, phone agent only, and combined use. See Supplement to Your Privacy Policy and the Data Privacy Overview and FAQ.

7. Add an imprint​

When publishing via a LoyJoy landing page, an imprint is legally required in some regions and can be exposed via the landing page, emails, or the chat. When embedding into your own website, your site's existing imprint usually applies.

8. Configure chat bubble and chat preview​

For the chat to be discovered and used, configure the chat bubble (launcher) and chat preview in the Branding tab. The bubble is customizable in shape, size, and animation, with separate sizes for desktop and mobile. The chat preview is the key discovery lever: the chat presents itself actively with a short message and one to three buttons instead of waiting for a click. A one-sentence value proposition plus up to three buttons works best. For social media and campaign links, the URL parameter loyjoy-open=true opens the chat automatically; alternatively use "auto-open" in Branding.

9. Optional: connect tracking​

Optionally connect a tracking tool such as Google Analytics, triggered by events in the chat. Not required for go-live. See Tracking Tool.