Installation and Configuration

Synerise works on customers’ online and offline data.
To analyze the activity of your customers, you need to track their actions on the website. You can do this by embedding tracking codes in your pages. You can also use Google Tag Manager.
If you have a web app with multiple pages, where each one triggers a new page refresh, you will most likely need the basic JavaScript method.

Embedding a tracking code in page source

Procedure: Paste the tracking code before the </body> closing tag of your website.

<script>
    function onSyneriseLoad() {
        SR.init({
            'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
        });
    }

    (function(s,y,n,e,r,i,se){s['SyneriseObjectNamespace']=r;s[r]=s[r]||[],
     s[r]._t=1*new Date(),s[r]._i=0,s[r]._l=i;var z=y.createElement(n),
     se=y.getElementsByTagName(n)[0];z.async=1;z.src=e;se.parentNode.insertBefore(z,se);
     z.onload=z.onreadystatechange=function(){var rdy=z.readyState;
     if(!rdy||/complete|loaded/.test(z.readyState)){s[i]();z.onload = null;
     z.onreadystatechange=null;}};})(window,document,'script',
     '//www.snrcdn.net/sdk/3.0/synerise-javascript-sdk.min.js','SR', 'onSyneriseLoad');
</script>

Available script variants

We have several variants of our Javascript SDK that you can use depending on the required features.

Fewer features usually result in smaller page size and shorter load times.

Script version URI
default:
Script with all functionalities
synerise-javascript-sdk.min.js
no-cm:
Script without Cookie Matching
synerise-javascript-sdk-no-cm.min.js
no-wp:
Script without WebPush
synerise-javascript-sdk-no-wp.min.js
no-m:
Script without Chat
synerise-javascript-sdk-no-m.min.js
no-wp-m:
Script without WebPush and Chat
synerise-javascript-sdk-no-wp-m.min.js
no-wp-cm:
Script without WebPush and Cookie Matching
synerise-javascript-sdk-no-wp-cm.min.js
no-wp-m-cm:
Script without WebPush, Chat and Cookie Matching
synerise-javascript-sdk-no-wp-m-cm.min.js
no-m-cm-wss:
Script without Chat, Cookie Matching, Automation-based Dynamic Content, and WebSockets
synerise-javascript-sdk-no-m-cm-wss.min.js

Additional configuration parameters

The only required parameter during the initialization of the tracking code is the trackerKey parameter.
By using the additional parameters described below, you can modify the configuration of the tracking code.

SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'dataLayer':dataLayer
});
  • You can turn off the automatic collection of page visit events with the customPageVisit parameter.
    In this case, events should be sent manually using the sdk methods.
SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'customPageVisit':true
});
  • If you use Synerise webpush and need to set a custom service worker scope (registration path), you can enter that path as a parameter.
SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'webpush':{
        'service_worker_scope':'/pl/'
    }
});
  • Additionally, if you need to disable some Synerise modules on a specific sub-page or domain, you can do it by specifying the parameters as below:
SR.init({
    'trackerKey':'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
    'disableMessenger':true,
    'disableFormMarker':true,
    'disableWebPush':true,
    'disableDynamicContent':true,
    'disableNotification':true
});
😕

We are sorry to hear that

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.

😉

Awesome!

Thank you for helping improve out documentation. If you need help or have any questions, please consider contacting support.