Our documentation is changing, please click here to enjoy it!

Skip to end of metadata
Go to start of metadata

You can collect opt-in users from any website, any domain or subdomain (such as yourwebsite.comyourwebsite.de, or shop.yourwebsite.com…), whether http or https, and have a unified database for your Web Push Notification messages.


In order to send Web Push Notifications to your website users, you first need to obtain their permission (‘opt-in’). We call the whole procedure to obtain user permission, the ‘opt-in process’.

This process has a strong impact on the volume of opt-in users.

Before explaining how to customize the opt-in process, we want to make you familiar with it and the different steps.

The user permission to send Web Push Notifications is obtained via a browser permission message, which is not customizable. It has a set design and wordings are decided by the browser.

 

Accengage provides you with 2 opt-in process :

  • One is done on the Accengage's domain (or a custom domain):
    • the opt-in process will be done through the Accengage's domain (or a custom domain) and users will be ask to opt-in through a landing page which, when displayed, will call the browser's native permission

    • This optinization process is available for websites in HTTP and HTTPs

    • Check out this documentation  to implement it
  • The other is done directly on your own domain :
    • the opt-in process will be done through your own domain and the browser's permission will be called directly without the display of a landing page (but you can set up one if needed)

    • to use this method you must integrate our SDK 3.3.x and activate this optinization method in your Accengage dashboard

    • this optinization process is available only for websites in HTTPs

    • Please, check out our FAQ to know how to implement this new process !

 

     

    Also, once the users have answered to this permission request (either with ‘allow’ or ‘block’), you will not be able to ask this permission again. If users have denied them previously, the only way users can allow them again, is to go through the browser settings... Not ideal !


    For this reason, Accengage recommends to first ask the user for its intention, with a customizable, full-html and attractive message (which is called ‘Alert’), and then, once the user has expressed will allow Web Push Notifications, to trigger the native browser permission.

    If the user does not express its intent to allow Web Push Notifications, then the permission will not be triggered, which allows you to ask for permission at a later stage. This is a great way to achieve better opt-in performance than by just triggering the native browser permission.


    The Accengage Web SDK provides a Pop-in ‘Alert’ by default, with numerous options for it to be customized simply (see the ‘basic customization’ paragraph). But Accengage also provides a library of more advanced and efficient scenarios, such as interstitial, full-length banners, buttons… (see the ‘advanced scenarios’ paragraph).

    We highly recommend you to customize the ‘opt-in’ process, as this can enhance significantly opt-in results.




    Also, as Web Push Notification permission can only be triggered on HTTPS websites, and users must give their permission for each domain or subdomain which want to send Web Push Notifications, Accengage has developed a solution to ease the process.

    This solution consists of the following:

    • Once the users have expressed their intention to accept Web Push Notifications through the ‘Alert’

    • A new Window is opened and displays an HTTPS landing page, with a unique MASTER DOMAIN (provided by Accengage)

    • In this landing page, the native browser permission is prompted (see below)

    • Once the permission is granted, the landing page registers the user to the Web Push Notifications and communicates all relevant information to Accengage.



    As a result, you can collect opt-in users from any website, any domain or subdomain (such as yourwebsite.comyourwebsite.de, or shop.yourwebsite.com…), whether http or https, and have a unified database for your Web Push Notification messages.

    See below an illustrated example used on our website in which we have customized some steps:


    Starting from version 3.3.x of the SDK Push Web, Accengage allows you to ask for the opt-in through your own domain name.

    This optout-to-optin process will follow these requirements : a link in your page > display of the browser's native permission

     

    Important

    This optout-to-optin process is available only for website working on HTTPs protocol.

     

    In order to benefit this process we recommend you to follow these steps after each other :

    (1/3) Edit the version number of your application :

    To get access to the new opt-in process of the SDK Web you should set your application version to 3.3.x.

    To do so, please go into your Accengage Dashboard : Settings > Manage application > Edit > Field Version : change it to our last version available "v3.3.x"

     

    Important

    At this stage, please keep the checkBox 'Use my own domain name' unchecked


    Click on "Save".

    Changes will take approximately half an hour before getting live.

    (2/3) Download and host to your web server the mandatory files :

    Once you've upgraded the version number of your application, to operate the new opt-in process needs a zip file to be downloaded from our interface.

    To download the zip file, please go to our interface > Settings > Manage Application > Click on the download icon at the right :


    Once you've downloaded the ZIP file, you should extract files from this ZIP. You should obtain 3 files :

    • acc_sw.js
    • acc_ww.js
    • manifest.json

    Once extracted, before going to the next step, please upload those files to the root directory of your website.


    The files "acc_sw.js" and "acc_ww.js" will be called by the SDK and the file "manifest.json" just has to be referenced in the pages where the snippet will be present.

     

    The optinization on your own domain needs a service worker running on your domain to operate (acc_sw.js)

    If you already host a service worker on your website, you'll have to merge the Accengage one with yours.

    To do so, add the lines below at the end of your service worker script :

     

    Important

    Those 3 files are only available for download to applications configured in the Accengage Dashboard with SDK's version number above 3.2.x (step 1/3)

    Those files should be uploaded to the root directory of your website, unless you already host a "manifest.json" file, you should merge the lines generated by the "manifest.json" downloaded from our interface to the "manifest.json" hosted on your server.

    Important

    You need to reference "manifest.json" in all your pages by including this tag in the <head> :

    <link rel="manifest" href="/manifest.json">

     

     

    If the "manifest.json" doesn't reside in your root directory please reference it like below :

     

    <link rel="manifest" href="/path/to/your/manifest.json">


    (3/3) Enable optin on your own domain name :

    Finally to set up the opt-in process you should enable it through the Accengage dashboard and the "modify web application" modal screen, to do so please go to our interface > Settings > Manage Application > Edit your Web App > check "Use my own domain name"

     

    Note

    Please keep the field "master domain name" unchanged.

    It should still be the domain provided by Accengage during your first integration.

    The master domain is referenced as .by-accengage.net or .notification.group if you have subscribed to a custom domain.

     

    Requesting directly the browser's native permission

    Starting from SDK 3.3.x, Accengage gives you different ways to ask a user to opt-in:

    • Display the pop-in alert (called showAlert) and then the browser's native permission (2 steps)

    or

    • Display the browser's permission when a user opens specific pages (1 step)

    or

    • Trigger the browser's permission when a user clicks on a specific link of your website

    What are the benefits of each process ?

    • Pop-in alert :

     

    It allows you to explain the benefits of your web push notification to the user.

    It can be customized to match with you're website appareance.

    Your optin process will contain 2 steps - more details in the section "3.2.1 Edit the JSON plugin configuration"

     

    • Display the browser's native permission on specific pages :



    You can display automatically the browser's native permission when a user opens a specific page of your website with your own domain name.
    To use this scenario you have to :
    1. Edit your JSON configuration on the Accengage Dashboard and set your scenario as "none" (it will prevent the display of the pop-in alert) - more details in the section "3.2.1 Edit the JSON plugin configuration" .
    2. Add the snippet on every page in which you want to display the browser's permission
      1. You want to ask the permission everywhere except page X ? Then add the snippet everywhere except page X.
      2. You want to ask the permission only on page Y; Z, W ? Then add the snippet only on these pages

    This method allows you to only have one step in your optinization process.

    Information

    Please note that if the snippet isn't integrate into a page, you'll not be able to track user's actions on that page.

     

    • Calling directly the browser's native permission :

    It gives you the possibility to display the browser's permission when a user clicks on a specific link of your website

    To do so :

    1. Edit your JSON configuration and set your scenario as "none" (it will prevent the display of the pop-in alert) - more details in the section "3.2.1 Edit the JSON plugin configuration" .
    2. Trigger the call-to-action method "requestBrowserPermission" when a user clicks on a specific link of your website :
    Argument Required Type Description
    options yes <array> of <string> containing selected anchors to bind. The value must start with "#" or "." (ID or ClassName)
    callbacks optional <object>
    • "onSuccess" : <array> provided elements that have been utterly binded
    • "onError" <string> label error
    For example


    Quick integration vs. customization

    Our solution can be fully configured. You can legitimately configure it to create the most adapted process according to the look and feel of your website.


    When you play the video, click on HD to enhance video quality

    In the following paragraphs, we will look at:

    • How to customize very easily the default Popin Alert which Accengage provides, as well as the Landing page and certain options

    • How to customize the Popin Alert in a more advanced way

    • How to create more advanced and efficient opt-in scenarios, to maximize results (we highly recommend you to create these)

    • Some useful commands to help you during these steps.

     

     

    This page intends to explicit some common use cases about the optout-to-optin customization


     

    • No labels