How to Install JS API

This essential integration uses a JavaScript snippet, a block of code inserted into your website. It’s a low-impact way to send data to SmartSender — through your users’ web browsers. While an API integration is more flexible, this is a quick way to get started.

Things to know before you start:

• We only track activity for users registered on your website after the JS Script is called.
• We do not track anonymous or unregistered user activity.
• To update an existing user’s variables, send the JS API call again. You must include their identification and any new attribute values.
• If the variables already exist in their profile, we’ll overwrite them.
• If there are any new variables included in the call, we’ll add them to the profile.
• We do not edit the user’s identification method if the contact is already added to the contact list.
• A JavaScript API makes it easy to get started but isn’t essential. You may do everything through our REST API.

Step-by-step instructions:

1. Navigate to the Integrations page (Menu -> Integrations).
2. Select the “JS code” section.
3. Click the “Add website” button.
4. Select the domain name in the header drop-down menu.
5. Select options and permissions from checkboxes. The code will change depending on the selected options.
   
6. Click the “Save” button.
7. In the opened tab, please copy the code and paste it on the desired page into your HTML.
8. You can place the same code on several pages – then all the subscribers will be collected in a Default Contact List.
   • IMPORTANT Keep in mind that at least one unique user identification ( userId| email | phoneNumber ) is required so SmartSender could match the contact with the one hosted in the Contact List.
9. Download and extract Worker File from the archive and add it to the root directory of your website
   • Alternatively, email all the settings to your Developer if you have a problem adding this code to the website.
10. IMPORTANT Include JS initialization and user identification snippets on every page in your website immediately before the closing tag to initialize JS API and identify your user.

<script type="text/javascript" src="//js.smartsender.io/js/v1/JS_SCRIPT_ID.js" charset="UTF-8"></script>

<script type="text/javascript">
    // Unique identifier of contact in the contact  list (email, phone or userId in your application)
    var contact = new _smartSenderContact('{{identifier}}');
</script>

<script type="text/javascript">
    // Properties of the contact described below in comments. Every parameter is optional.
    var options = {
        firstName: '{{contactFirstName}}'  // optional (firstName  in string format)
    };

    // Contact creation method can be called at any event on your website page.
    contact.Add(options);

    // Contact update method can be called at any event on your website page.
    contact.Update(options);

    // initialisation of event object. Params: 1) id or name of event registered in the system - required. 
    2) event value - optional value in float or integer format correspondingly, dot divider. 
    3) event currency - optional. Please use only currency EUR, USD. Latin uppercase format. 
    var event = new _smartSenderEvent('{{eventIdOrName}}', '{{value}}', '{{USD}}'); 

    // event firing method can be called at any callback on your website page contact.FireEvent(event);

    //Show web push prompt modal method.
    contact.ShowPushPrompt();

    // Add telegram subscription link
    contact.CreateTelegramSubscriptionLink('{{domElementId}}', '{{telegramBotId}}');

    
</script>

After inserting the code on your site, make your first JS API call and check the integration status.

• • • Navigate to the Integrations page (Menu -> Integrations).
    • Select the “JS code” section.
    • When the first successful JS API call is done, the installation will be validated, and the status will change to “Connected.”
    • If the website status is “Not connected”, it is necessary to check the applied settings once again.
    • If the website status is “Connected”, you will be able to create and update contacts, manage their data and subscription.

    Important Web Push notifications are available in Pro and Enterprise Plans.

    JS API can be installed using Google Tag Manager.