Personyze Technical Implementation Guide
A step-by-step resource for developers and technical teams. Learn how to install the tracking code, define content placeholders, configure conversion goals, and integrate your data stack.
Start NowInstall Personyze on Your Site
To enable personalization, you must install the tracking snippet on every page of your site. Choose the method that matches your platform.
Option 1: Google Tag Manager (GTM)
Option A: Custom HTML (Manual)
Create a "Custom HTML" tag, paste the full Personyze JS snippet, and trigger it on "All Pages".
Option B: Template Integration (Easiest)
Search the GTM Community Gallery for "Personyze Tracking Code". Add it, enter your Site ID, and trigger on "All Pages". This keeps your container clean.
Option 2: Standard HTML
Paste the snippet directly into the <head> tag of your master template file. Ensure it is placed as high as possible, immediately after your charset and viewport meta tags.
Option 3: CMS Instructions
theme.liquid. Paste code before </head>.header.ftl template.Define Placeholders (Zones)
Placeholders are areas on your site where Personyze injects content. Using placeholders instead of popups makes personalization feel native.
Option A: The Visual Selector (No-Code)
- Create a new Campaign and add a "Banner" action.
- In Display Settings, choose "Show in placeholder".
- Click "Find on pages" to open the Simulator.
- Navigate your site and simply click the element (e.g., Hero Banner) you want to turn into a zone.
Option B: Manual CSS Selectors
Manually enter IDs or Classes like #home-hero or .sidebar-widget.
Max Simultaneous Actions: Allows stacking multiple banners vertically (e.g., show Banner A AND Banner B).
Conversion Goals & KPI Tracking
Track ROI by defining what success looks like. You can track simple clicks or complex revenue data.
1. Goal Types
- URL Destination: Triggered when user visits a specific URL like
/thank-youor/order-confirmed. Best for lead generation. - Track Activity: Track specific interactions like clicking "Add to Cart", hovering over a menu, or watching a video. Use the Visual Selector to pick the element.
- Grab Data (Revenue): Extract dynamic values (e.g., "$150.00") from the page HTML or a cookie. Essential for calculating ROI and Revenue.
- External Events: Automatically capture events pushed to the GTM Data Layer or Google Analytics events without extra setup.
2. Advanced Settings
- Goal Value: Set a Fixed Value (e.g., Lead = $10) or a Dynamic Value (grabbed from the page, like Purchase Total).
- Frequency: Set "Once per visit" for leads (to avoid duplicate counts on refresh) or "No Limit" for purchases (to track every transaction).
3. E-Commerce Metrics
If you enable product/revenue tracking, Personyze automatically calculates Total Revenue, AOV (Average Order Value), and Contribution Rate (how much revenue was influenced by personalization).
Extract Site Data (Variables)
Enhance targeting by "grabbing" data from the visitor's browser or page session to build a rich user profile.
Supported Data Sources
You can create a "User Profile Variable" from any of these sources:
- Page Elements (HTML): Scrape text visible on the page (e.g., "Hello, [Name]" or "Points: 500"). Use the Visual Selector.
- Cookies: Read values stored in browser cookies (e.g.,
login_status,affiliate_id). - JavaScript Variables: Read global JS variables (e.g.,
window.userLevelordataLayer[0].userId). - Meta Tags: Read SEO meta tags to understand content context (e.g.,
<meta name="author" content="John">). - URL Parameters: Read UTMs or query strings (e.g.,
?campaign=summer_sale).
In-House CRM & Data Integration
Connect your internal databases (custom CRM, SQL, ERP) with real-time website behavior.
Integration Methods:
- CSV Upload: Manually upload lists of User IDs + Attributes (VIP Status, Industry, Offline Purchases).
- Live Feed: Sync via a Google Sheet URL or HTTP Feed that updates automatically.
- API: Use the Personyze API to push user updates in real-time from your backend.
Product & Content Feed
This is required for running Product Recommendations AND Article/Content Recommendations.
1. Prepare Your Feed
Personyze accepts CSV, XML, JSON, RSS, Atom, or Google Merchant Feeds.
2. Map Your Columns
Go to Settings > Data & Content > Product Feed. You must map the fields in your feed to Personyze attributes:
- Internal ID: MUST match the Product/Article ID found on your live page (SKU/ID) or GTM variable. This allows Personyze to know which item the user is currently viewing.
- Title: The name of the product or article.
- Image URL: For displaying in recommendation widgets.
- Link URL: Where the recommendation clicks to.
- Price / Category: For filtering and logic.
Alternative Methods
- Site Crawler: If you don't have a feed, contact your account manager to set up a crawler that builds the feed from your site automatically.
- SFTP Upload: For large enterprise catalogs, ask your account manager to enable secure SFTP upload.
Privacy & Opt-Out
Ensure compliance with GDPR/CCPA by integrating with your Consent Management Platform (CMP).
JavaScript API:
Use these commands inside your Cookie Banner's "Accept" or "Decline" logic:
_S_T.system.off(): Stop Tracking. Call this if a user declines cookies. No data will be sent._S_T.system.on(): Start Tracking. Call this when a user accepts cookies._S_T.system.is_on(): Returnstrue/falseto check current status.
Strict Mode: You can configure Personyze to run in "Strict Mode" where it doesn't track IPs or PII by default until explicit consent is given via the command above.
3rd Party Integrations
Plug-and-play integrations with the tools you already use. To access these, go to: Settings > Integrations.
Analytics & Data
Send Personyze audience and campaign data to your analytics tools for reporting.CRM & Marketing
Bi-directional sync of leads and user attributes between Personyze and your CRM.ABM & B2B Data
Enrich anonymous traffic with Company Name, Industry, and Revenue data.Infrastructure
Connect backend systems, authentication, and workflow automation.Email Sender Configuration
Configure how Personyze sends your triggered emails and newsletters.
Option A: Default Sender (Amazon SES)
By default, Personyze uses Amazon SES. You can authorize your own "From" address (e.g., info@yourdomain.com).
- Add your desired email in Personyze settings.
- You will receive a verification request from AWS.
- Recommendation: Contact your account manager to get DKIM records to upload to your DNS for better deliverability.
Option B: Custom SMTP
Use your own mail server (SendGrid, Mailgun, Outlook, etc.) for full control.
- Select "Mail provider (SMTP)".
- Enter your Host, Port (e.g., 465 or 587), User, and Password.
Option C: Webhook (HTTP POST)
Send the email data payload to your own endpoint or automation tool (like Zapier) to trigger the send externally.
Web Push Notifications Setup
To enable browser push notifications, you must install a Service Worker.
1. Download the Service Worker
Download the standard file: sw.js
2. Install on Your Server
- Scenario A (No existing Service Worker): Upload the `sw.js` file to the root folder of your website (e.g., `yoursite.com/sw.js`).
- Scenario B (You already have a Service Worker): Do NOT overwrite your file. Instead, ask your developer to merge the contents of our `sw.js` into the top of your existing service worker file.
Note: Each site can only have one active Service Worker file.
Personyze REST API
Integrate Personyze programmatically with your backend systems to read or write data.
Capabilities
- User Data: Push CRM data or update user profiles.
- Content: Update your product or content catalog.
- Events: Report offline conversions or backend events.
Mobile SDK (iOS & Android)
Extend personalization to your native mobile applications.
Features
- Unified Profile: Track users across Web and App.
- Native Targeting: Use app-specific behaviors for segmentation.
- Push Notifications: Trigger personalized alerts.
Single Sign-On (SSO)
Manage access to the Personyze dashboard using your enterprise identity provider.
Centralized user management, one-click access for employees, and enhanced security compliance.
Supported Providers
- Auth0
- Okta
- OneLogin
- Xecurify
Setup Instructions
- Go to Settings > Integrations > Single Sign On in the Personyze console.
- Select your provider from the list.
- Enter the required Metadata URL or Certificate details from your IdP.
- Save and test the connection.