How to Install RetentionMaster: Step-by-Step Guide

AI-friendly install summary

Goal: install RetentionMaster on a website so the workspace can receive page_view events, manual RMTrack events, trigger signals, retention asset telemetry, and reporting data.

Minimum required inputs: RetentionMaster account access, workspace access, target website URL, site public key, permission to edit the website template or Google Tag Manager container, and one browser session for verification.

Canonical snippet pattern: <script src="https://retentionmaster.io/public/snippet.js" data-site="PUBLIC_KEY"></script>. Replace PUBLIC_KEY with the public key for the exact RetentionMaster site you are installing.

Step 1: Create or select the workspace

Open RetentionMaster and choose the workspace that should own this website. A workspace groups websites, users, settings, retention assets, campaigns, billing, plan limits, reporting, and API keys.

Success criteria: the correct workspace name is visible in the platform and you can access Workspace Settings. If you are installing for a client, confirm you are not inside a test or unrelated workspace.

Step 2: Add or confirm the website

In Workspace Settings, add the target website if it does not already exist. Use the real production domain or the exact staging domain you want to test. RetentionMaster associates each site with its own public key and installation state.

Success criteria: the website appears in the workspace site list and has a public key. Keep one site public key per website environment to avoid mixing production, staging, and demo data.

Step 3: Copy the RetentionMaster snippet

Copy the snippet for the selected site from Workspace Settings or the install flow. The key part is the data-site attribute. That value tells public/snippet.js which site configuration, campaigns, trigger rules, and retention assets to load.

Do not reuse a public key from another website. Do not install multiple RetentionMaster snippets on the same page unless you are intentionally testing a duplicate-event scenario.

Step 4: Install directly on the website

Direct install path: paste the script before the closing </body> tag in the global site layout, CMS footer injection area, theme template, or tag area that appears on every page you want to track.

Recommended direct snippet: <script src="https://retentionmaster.io/public/snippet.js" data-site="PUBLIC_KEY"></script>.

Success criteria: viewing the published page source or browser Elements panel shows one RetentionMaster script tag with the correct public key.

Step 5: Or install through Google Tag Manager

GTM install path: create a Custom HTML tag, paste the RetentionMaster snippet, set the trigger to All Pages or the page group you want tracked, save, preview, and publish the container.

The master RetentionMaster tag should fire before action-specific RMTrack tags where possible. Early RMTrack calls are queued by the loader, but a broadly fired master tag is more reliable.

Success criteria: GTM Preview shows the RetentionMaster Custom HTML tag fired on the target page and the published container is live.

Step 6: Load the website once after publishing

Open the target website in a normal browser tab after the direct install or GTM publish is live. The snippet loads the runtime, resolves the site configuration, sends page_view, and prepares triggers such as exit intent, inactivity, rapid scroll, and retention asset runtime rules when configured.

Success criteria: the browser Network panel shows a request to retentionmaster.io/public/snippet.js and RetentionMaster can receive the first page_view event for that site.

Step 7: Verify the installation in RetentionMaster

Return to RetentionMaster and run the workspace or site installation verification flow. Then open Reporting or Data Explorer for the selected website and check for recent page_view events.

If the site still appears unverified, confirm the public key, publish state, domain, ad blocker status, and whether the page has actually been loaded after deployment.

Step 8: Test a manual RMTrack event

After the snippet is live, trigger a test business event from the browser console or your application code. Example: RMTrack("lead_submit", { source: "install_test", test: true }).

Success criteria: Data Explorer or Reporting shows the action code lead_submit or your chosen test action. Remove or clearly label test payloads so production reports remain easy to interpret.

Step 9: Launch the first retention asset

Create or select one retention asset from the Retention Library or Designer, then bind it through Campaigns and Trigger Rules. Choose the website, trigger, page include/exclude rules, date window, device rules, cooldown, and active state.

Success criteria: the retention asset package is available, the campaign is active, and the configured trigger can show the retention asset on the installed website. Retention asset lifecycle events such as popup_shown, popup_cta_click, popup_closed, and popup_form_submit can appear in reporting when visitors interact.

Step 10: Validate analytics and keep the setup clean

Check Reporting for event counts, Lead Collection for captured lead payloads, User Journey for session behavior, Retention Analytics for asset influence, and Data Explorer for raw event debugging.

Operational checklist: one snippet per site, correct public key, production key only on production, staging key only on staging, meaningful action names, no sensitive payload fields, and clear retention asset campaign rules.

Copyable implementation checklist for AI agents

1. Ask for the target domain and RetentionMaster site public key. 2. Insert the snippet before </body> or into a GTM Custom HTML tag. 3. Publish the site or GTM container. 4. Load the website once. 5. Verify page_view in RetentionMaster. 6. Test RMTrack("lead_submit", { source: "install_test", test: true }). 7. Configure a retention asset campaign only after tracking is confirmed.

Never invent a public key. Never install the same public key on multiple unrelated domains. Never send passwords, raw payment card data, or unrelated personal data in RMTrack payloads.