Basics
To get started with On-site messages for your website you will need an account on xtremepush and a web app project. You can login at dashboard.xtremepush.com. Once logged in if you don't have one ready to use, add a NEW web App project.
Don't have a login?
If you are already a customer all accounts come with multi-user access and the person(s) in your organisation who is responsible for administration of user access will be able to provide appropriate user access to users who are; involved in the integration process, running campaigns etc. If you need help please contact your account manager or submit a support ticket.
If you are not a customer please request a demo.
If you are creating a New web App project you will need to enter the following details and click save to initialise your project:
-
Title: Name used to identify project on the platform, something obvious to help you find it.
-
Timezone: The timezone used for analytics in the project. Important this will dictate the starting point for analytics like daily users. You can set this to the local timezone of platform users if this makes sense. Default is UTC, which is a good compromise if users are likely to be spread across different timezones.
-
Description: A short description of what the project is for.
-
Website Name - The brand name of your site
-
Website Domains - Whitelist of site domains that you will be using - required.
- Include http protocol prefix - https://example.com
- If using multiple domains place the different domains on separate lines
-
Icons: The default icon use .png format to be displayed in your web push notifications - required.
-
Small icon - 64px x 64px
-
Large icon - 256px x 256px
-
Deploying the SDK
If you have already setup web push notifications on your site the SDK will already be deployed and you can skip to the next section. If not you will need to deploy the SDK. In your web project there is a page called App Settings > SDK Integration.
It will have the code you need for deploying the SDK like below:
This is javascript deployment code that you will need to add to your site and there are instructions on how to deploy on this page also.
You can also deploy the SDK with Google Tag Manager
Adding Realtime Events to Trigger Messages
On-Site messages are triggered by realtime events. You need at least one realtime event for example a specific page view to have an On-Site message. Once the SDK is deployed you can add these events easily by calling a simple javascript method. Trigger events can be added to your site very simply using the event method of the xtremepush web SDK.
xtremepush('event', 'EVENT_NAME');
These can also include values similar to tags:
xtremepush('event', 'EVENT_NAME', 'EVENT_VALUE');
For more detail on events and how they can easily be added using a tag manager product like GTM and for info on special events such as Mouse Out and Page Scroll see articles linked below:
If you want to very quickly call a trigger event to test a campaign you can make a call from the browser console as shown below:
Enabling the On-Site Messaging Channel
To find out if the On-Site Messaging Channel has been enabled Go to Create Campaign > On-Site Message.
If you are redirected to the App Settings > Additional Channels page you will need to set On-Site Messaging to Enabled and click save.
Return to Create Campaign > On-Site Message and you should now be taken to the Campaign Creation interface:
Setting Up a Message
Before you set up your first message please review our creative guidelines for On-Site Messages to get an understanding of how to create professional looking messages:
Then provided you have set up at least one trigger event you can you are ready to setup your first campaign. Campaign setup is covered in our Platform Guide Docs:
In addition to on-site messages events can also be used to trigger notifications. One common use case for these is basket or other drop-off recovery type notifications,
Comments
0 comments
Article is closed for comments.