Documentation

  1. GETTING STARTED
    1. Introduction - New Users
    2. Understanding The Dashboard
    3. Adding Custom FCM ID & Key
  2. INSTALLATION
    1. Install with Javascript
    2. How to Add the Tracking Code with Google Tag Manager
  3. OPT-IN PROMPTS
    1. Subscriber Permission Prompt Management
    2. Customizing the Opt-In Prompt
    3. Remove/ Delete A Prompt
    4. (Mac) How Default / Native Opt-In Prompts On All Browsers Look.
    5. (PC - Windows) How Default / Native Opt-In Prompts On All Browsers Look.
    6. (Mobile) How Default / Native Opt-In Prompts On All Browsers Look.
    7. Why am I not seeing the push notification prompt?
    8. How do I block the Opt-In Prompt from appearing in the inside page of the website?
    9. Can I delay how long it takes for my Opt-In Prompt to display?
    10. Is there a way to customize the prompt so that is is bigger and stays centered on the page?
  4. CAMPAIGNS
    1. Creating a Manual Campaign
    2. Creating a Triggered Push Campaign
    3. Creating RSS Feed Campaigns
    4. Creating Welcome Push Notification Campaigns
    5. Sending Test Push Notifications
    6. Why did my push go out to fewer subscribers than expected?
    7. Why are my manual notifications not being sent and are stuck on "scheduled."
  5. SEGMENTATION
    1. Creating a Segment
    2. Understanding Custom Events
    3. Understanding Custom Attributes
    4. Examples of Segments to Help You Get Started.
    5. Segmentation Options
  6. ANALYTICS
    1. Viewing Campaign Results
    2. Data collected for subscribers
    3. Tracking Abandoned Carts
  7. IMPORT/EXPORT
    1. Can I Import Subscribers From Another Push Vendor?
    2. (Basic) Can I Export My Subscribers?
    3. (Advanced) Can I Export My Subscribers?
  8. TEAM MEMBERS
    1. Leveraging Team Members
    2. Adding Team Members
    3. Sharing Access with Non Team Members
  9. ADVANCED
    1. Using Variables in Notifications (Attributes)
    2. Using Variables in Notifications (Events)
    3. Enabling Persistent Notifications
    4. Triggering Javascript After Prompt Approval/Denial
    5. Conversion Tracking
    6. How to Set Up Abandoned Shopping Cart Notifications
    7. Web Push Content Gating
    8. Trigger Phone Call From Notifications
  10. MANAGING PUSH NOTIFICATIONS SETTINGS
    1. Chrome (Desktop)
    2. Chrome (Mobile)
    3. Safari (Desktop)
    4. Firefox (Desktop)
    5. Firefox (Mobile)
    6. Opera (Desktop)
    7. Opera (Mobile)
    8. Unsubscribing From Web Push
  11. INTEGRATION
    1. (API) Generic Functions
    2. (API) Callback Functions
    3. REST - LOGIN
      1. (API) Get User
      2. (API) Update User
    4. REST - WEBSITES
      1. (API) Get All Websites
      2. (API) Get Website Code
      3. (API) Add Website
      4. (API) Update Website Name
      5. (API) Update Website Icon
      6. (API) Update Website Push Package (Safari)
      7. (API) Delete Website
    5. REST - ATTRIBUTES
      1. (API) Get Custom Attributes
    6. REST - SUBSCRIBERS
      1. (API) Get Subscriber
      2. (API) Add Subscriber Attribute
      3. (API) Add Subscriber Event
    7. REST - SEGMENTS
      1. (API) Get All Segments
      2. (API) Get Segment
      3. (API) Get Suggested Segment Value
      4. (API) Update Segment
      5. (API) Delete Segment
      6. (API) Create Segment
    8. REST - MANUAL CAMPAIGNS
      1. (API) Get All Manual Campaigns
      2. (API) Get Manual Campaign
      3. (API) Get Manual Campaign Clicks
      4. (API) Get Manual Campaign Results (By Day)
      5. (API) Create Campaign
      6. (API) Update Campaign
      7. (API) Delete Campaign
    9. REST - TRIGGERED CAMPAIGNS
      1. (API) Get All Event Triggered Campaigns
      2. (API) Get Event Triggered Campaign
      3. (API) Get Event Campaign Results (By Day)
      4. (API) Create Event Triggered Campaign
      5. (API) Update Event Triggered Campaign
      6. (API) Delete Event Triggered Campaign
    10. REST - API CAMPAIGNS
      1. (API) Get All API Push Campaigns
      2. (API) Get API Campaign
      3. (API) Get API Campaign Results (By Day)
    11. REST - SEND PUSH NOTIFICATIONS
      1. (API) Send Push Notification
    12. REST - LOGS
      1. (API) Get Notification Logs
      2. (API) Get Attributes Logs
      3. (API) Get Pageview Logs
  12. FAQS
    1. Does my site support HTTPS?
    2. Is SSL/HTTPS required?
    3. Is it possible to trigger the browser notification prompt to join when someone clicks on a link/image/button?
    4. Do I need to provide my own certificates and/or have a Safari Developer license?
    5. Which platforms/browsers are supported?
    6. How do I select my time zone when scheduling notifications?
    7. Best Practices and Tips
    8. (Mac) How Are My Notifications Supposed To Look?
    9. (PC - Windows) How Are My Notifications Supposed To Look?
    10. (Mobile) How Are My Notifications Supposed To Look?
    11. Notification Tray: Where do your notifications go if they disappear?
    12. How to send a triggered notifications after someones subscribes
    13. Message Inbox
    14. Message Inbox - Tracking Issue
  13. LEGAL
    1. Refund Policy
    2. Privacy Policy
    3. Terms & Conditions

Introduction - New Users #

Unified Products & Services Push Notification helps marketers send targeted web push notifications to clients, customers, and other interested parties. In this article, you’ll learn some basics about how to use unifiedps and find resources that can help you as you work.

BEFORE YOU START

Push Notification is a web-based application that works in most web browsers, which means you don’t need to download or install any software on your computer. Furthermore, desktop push notifications are relatively new and support for them increases every day. That said, notifications are currently supported on:

  • Chrome (Desktop)*
  • Chrome (Mobile – Android)*
  • Safari (Desktop)
  • Firefox (Desktop)*
  • Opera (Desktop)*
  • Opera (Mobile – Android)*

*Requires HTTPS website. If you are not sure if your website is HTTPS, take a look at our FAQ.

Once you sign up for the trial you will be taken to the “Welcome Screen.” On this screen you will be given three choices on how to install.

The three ways you can install are: Shopify, WordPress, or Manually.

ADDING YOUR FIRST WEBSITE

The foundation of unifiedps is the tracking + notification software which is installed on your site. By uploading two small files and adding a tracking snippet to the footer of your site, you will instantly be able to have users opt-in to receiving notifications to your site while simultaneously tracking anonymous information.

REGISTRATION

To register your first site click “Integration” -> “Add Site” when you are in the dashboard.
At this point you are presented with three areas to fill out:

  • Icon – the image you want to use for your push notifications
  • Name – a custom name for your site (this is not shown to users)
  • URL – the URL of your site (be sure to include “https://” such as “https://unifiedps.com“.

After filling out the information above, click “Create”. Our software will prepare all the requirements on your behalf and in a few seconds your site will be created.

INSTALLATION

Once your site is ready you will need to install the tracking code and upload the required files. You should automatically be redirected to the installation page but if not you can go to “View Websites”, click edit on the site you are working on and then click “Tracking Code”.

There are two things you need to complete:

  • Download the required files and upload them to your sites root directory. (not sure what that means, check out our FAQ)
  • Click “View Tracking Code” and copy and paste the snippet on the footer of every page you wish to track (note: you must install this on the homepage in order to properly work).

VIEWING SUBSCRIBERS

After your tracking code is properly installed your website visitors will automatically be prompted to receive notifications from you. These users, after accepting, are now referred to as “subscribers”.
You can view all of your subscribers under “Subscribers” -> “View Subscribers”. Basic information is automatically tracked for each user including deviceType, location, browser, etc. If you would like to add custom information check out our article here.

SENDING A PUSH CAMPAIGN

The next part of push notification marketing is crafting the push message itself. You can do so by heading to “Push Notifications” -> “Add Campaign”.
Under the Create Campaign section you are guided through creating your campaign including: Name (not shown to subscribers), Segment (who you want to send it to), Push Title, Body, Link and the schedule date. Notifications that are marked as scheduled are automatically sent within 10 minutes from their schedule date.

VIEW REPORTS

After a campaign is sent you can view the report under “Push Notifications” -> “View Campaigns” -> “View Results”. Reports show the number of notifications sent and clicked, based on a given date range.

THAT’S IT!

Now you are ready to start taking advantage of Web Push Notifications! If you need any support along the way create a ticket within the dashboard or email us at support@unifiedps.com

Yes No

Understanding The Dashboard #

 

The dashboard provides a quick overview of everything that is happening with your currently selected website.

Currently there are 6 different ways you can view your site data on the dashboard:

1. New Subscribers – Users who accepted your sites push notification on any given day.

2. Notifications Sent – Cumulative total of all notifications sent out (individual, campaign, auto)

3. Notifications Clicked – Cumulative total of all notifications clicked (individual, campaign, auto)

4. Opt-In Rate Percentage – Percentage of users which approved or accepted push notifications from your website. This number is based off the total number of users who received the prompt, not all users (since for instance, users on safari on iPhone would not get the prompt)

5. Events Triggered – Number of custom events triggered by subscribers. View our article on getting started with custom events.

6. Custom Attributes Triggered -Number of custom attributes triggered by subscribers. View our article on getting started on attributes.

Additionally, you may filter this data based on any date range and or a custom segment you have created. If you have not created any segments, you can check out our documentation here on how to get started with segments.

Yes No

Adding Custom FCM ID & Key #

To set up your own FCM ID and Key follow the following steps:

1. Create New Project on Google Developers Console

Head to https://console.firebase.google.com/ and create a new project.

*2. Click the COG icon and select ‘Project Settings’

3. Get credentials

Select the “Cloud Messaging” tab in the navigation and then make sure you grab the “Server key” rather than Legacy Server key.

4. Add Credentials

Head back to your unifiedps dashboard and then go to “View Websites” > “Edit” > “Advanced Settings”. Once there, add your API key and Sender ID into the corresponding fields. Hit save/update.

5. Update your manifest

Last but not least you’ll need to update your unifiedps-manifest.json file that you uploaded to the root directory of your website. If you haven’t downloaded it yet (ie you just added your website) you can find this “View Websites” > “Edit” > “Installation”.

Simply open the unifiedps-manifest.json file and update the “gcm_sender_id” field with your Sender ID and upload it back to your server.

Congratulations! You have now successfully added your own FCM keys.

Yes No

Install with Javascript #

This tutorial walks through the steps to install UnifiedPS’s web push notifications manually.

STEPS

1. Add your website
To add a website to your push account, log into your dashboard (https://push.unifiedps.com/) and go to “Websites” > “Add Website”.

Select “Manually Install On Site.”

At this point you are presented with three areas to fill out:

  • Icon – the default image you want to use for your push notifications. You’ll be able to change it per campaign, but this will be a fallback.
  • Name – a custom name for your site (this is shown to users on certain browsers such as Safari)
  • URL – the URL of your site (be sure to include “https://” such as “https://unifiedps.com“)

 

The majority of browsers require your website to support HTTPS in order to have visitors subscribe. If you are unsure if your website supports HTTPS, please refer to here.

After filling out the information above, click “Create”. Our software will prepare all the requirements on your behalf and in a few seconds your site will be created.

2. Upload the required files to your website

Once your site is ready you will need to install the tracking code and upload the required files. You should automatically be redirected to the installation page but if not you can go to “View Websites”, click edit on the site you are working on and then click “Installation/Tracking Code”.

Download the required files and upload them to your sites root directory. (this means they should be accessible at https://yoursite.com. i.e. https://yoursite.com/unifiedps-worker.js and https://yourwebsite.com/unifiedps-manifest.json)

3. Upload the tracking code to your website

Click “View Tracking Code” and copy and paste the snippet on the footer of every page you wish to track (note: you must install this on the homepage in order to properly work).

That’s it!

Now your website should start prompting visitors to subscribe when they visit it. If you’d like to manage which pages prompt users to subscribe, check out Subscriber Permission Prompt Management

Yes No

How to Add the Tracking Code with Google Tag Manager #

In this documentation, we are going to show you how to install the UnifiedPS push tracking code on your website using Google Tag Manager.

First, Click Add New Tag

Then, select the ‘Choose a new tag’ to begin.

Next, find your push tracking code

Website > Edit > Installation and then Copy and Paste that into the box.

Scroll down and click on the ‘Choose a trigger’

Then on the next page, select ‘All Pages’

Hit save and click back to your workspace.

Then click ‘submit’ on the top right.

On the next screen, fill out your version number and hit ‘Publish.’

Your site should now prompt people to subscribe.

Note

Remember, you still need to place the two files (worker.js and manifest.json) on your site if you haven’t already.

Yes No

Subscriber Permission Prompt Management #

By default, all visitors to your site will receive a prompt automatically asking if they want to subscribe to your website. If you’d like to change when this prompt shows, follow the steps below.

Steps

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Websites’ located in the navigation bar on the left side of the screen. Selecting ‘Websites’ will open a small drop down window with two options- ‘View Websites’ and ‘Add Websites.’ Select ‘View Websites.’

This will take you to a list of all current websites you have that are set up to use unifiedps. There is a column titled ‘AutoPrompt’ and if the word ‘True’ is displayed in this column next to a particular website then this means that your prompt will automatically be displayed when a user navigates to this page. Select ‘Edit’ next to the website you wish to customize.

Selecting ‘Edit’ will bring up your options for updating your website. Click the second tab titled ‘Prompt Management.’

This is the area where you determine which page will display your push notification permission prompt. If there is only one page listed, the default logic will be set (as in when a user navigates to this page, the prompt will be shown). If you wish to change this, select the blue button ‘Add Condition.’ You may add as many conditions as you like.

Enter in the page URL you wish to include along with the priority number ranking as well as if you want to employ the Auto Prompt feature. If ‘False’ is selected, this means the prompt will not automatically be shown when the user navigates to the page. Click ‘Add’ to include this condition. The conditions with the highest priority ranking will always take place.

You may also select which Prompt you wish to display. You can either select the default (native) prompt or one of your custom prompts. To learn more about custom prompts, check out our documentation here.

Note: You can also trigger these prompts manually for when a user selects a particular link image or button. Learn how to do this by clicking here.

Yes No

Customizing the Opt-In Prompt #

In this document we are going to show you how you can set up custom opt-in prompts for your website. Let’s get started.

Steps

Start off by logging into your UnifiedPS push account and opening your dashboard. On the navigation bar, click the button titled Prompts, and then select ‘Add Push Prompt.’

This will take you to our Create Prompt window where you will choose a name for your custom prompt. Input the name and click ‘Create Prompt.’

This next screen is where you will input all of the information for your custom prompt. Our custom prompts allow you to create your own headline, body text, and button text. You can also choose the font colors for these elements as well.

As you input your information, the Prompt Quick Preview will automatically update to reflect your changes. The preview displays exactly how the notification will display to your users, so make sure you are happy with how the prompt looks before finishing.

The colored squares are what you select to change the font colors. The second squares next to the Cancel and Approve buttons allow you to select a background color for the buttons.

When you are happy with your prompt, click ‘Update Prompt’.

Now that you’ve created your custom prompt, you’ll need to specify when it should show to your subscribers. You can do this by clicking the ‘Prompt Management’ link below the Prompt Quick Preview to make that change. If you need help with prompt management, read our walk-through on it here.

Advanced Customization Using CSS

To customize your opt-in prompts even beyond our prompt management tool, you can easily apply custom CSS on your website. Below are the main elements which you can manipulate.

pushboxcontainer = main container
noticlose = close icon
noticon = the bell icon
notibody = body text (main heading and byline)
teaser = main heading
teaser-byline = byline
button-approve = approve button
button-deny = deny button

Example 1: Changing the Font Size

For instance you could change the font size of the byline text by adding the following snippet to your website:

To avoid conflicts with other CSS properties, we recommend you get as granular as possible when applying the style. Below is an example of a script for your convenience:

Example 2: Changing the Bell Icon

If you’d like to change the icon that is used for the notification bell, you can use the following code. Simply replace the URL with the URL of your icon and paste this on your website before the closing ‘</body>’ tag.

Yes No

Remove/ Delete A Prompt #

**To remove or delete a prompt, you can either:**

  1. Change the priority of the prompt back to default.

Or

  1. Remove your custom prompt completely.

To do so first go to “View Push Prompts”

From here you can click on the “edit” link on the prompt you would like to change.

From here you can either change the text of the existing prompt OR click the red “Delete Prompt” button to remove it completely.

You will be asked if you are sure that you want to delete your prompt. If your prompt is NOT in use, you can go ahead and delete it.

Note

If the prompt you are trying to delete IS in use you will have to change its status in order to delete it.

If the prompt you are trying to delete is in use, you will have to change its status by clicking the “Prompt Management” link that is just above the red “Delete Prompt” button.

Once in the Prompt Management tab, click on the “edit” link next to the prompt that you need to change.

In the edit screen it will show you the prompt that is in use. You can click the drop down tab to either change the prompt to “default” or another custom prompt that you have created.

Once the prompt is set to a different custom prompt or “default”. The prompt you wanted to remove will no longer be displayed for your customers. You could either leave the changes as is, or go back to edit your prompt and delete it entirely.

Yes No

(Mac) How Default / Native Opt-In Prompts On All Browsers Look. #

Chrome

Safari

Firefox

Opera (Desktop)

Note: Website Push Notifications will only prompt on websites supported by HTTPS. Opera browsers don’t show the (https://) in the URL bar.

Yes No

(PC - Windows) How Default / Native Opt-In Prompts On All Browsers Look. #

Chrome

Firefox

Opera (Desktop)

Yes No

(Mobile) How Default / Native Opt-In Prompts On All Browsers Look. #

Chrome (Mobile)

Firefox (Mobile)

Opera (Mobile)

Yes No

Why am I not seeing the push notification prompt? #

There are a few potentials reason why you are not seeing the website push notification (opt-in) prompt when you visit your website. Below are some of the most common reasons.

Reason #1: You’ve already approved permissions.

Subscribing to a push notifications are so easy, sometimes we do it without realizing it. Check to see if you’ve already given the site permissions by either following these instructions for Chrome/Firefox or these instructions for Safari.

Reason #2: Your browser doesn’t support push.

Currently website push notifications are supported on: Safari(Desktop), Firefox(Desktop), Chrome(Desktop and Mobile on Android) and Opera (Desktop and Mobile on Android). If you are using a device not listed (like iPhone) you will not be able to subscribe to a website. That’s a limitation directly from Apple which we hope changes soon.

Visitors on unsupported devices will see your site as normal. Currently about 80% of desktop web traffic adn 45% of mobile website traffic supports website push notifications.

Reason #3: Your website already has another manifest.json file (advanced)

In some rare cases, push notification prompts will not appear because you already have a manifest.json file on your website that conflicts with the push-manifest.json file. If this is the case, simply copy over the “gcm_sender_id” field from our manifest to yours.

For instance, let’s say your existing manifest.json file looks like this:

  • JSON

Then you would update it to look like this:

  • JSON

Still having trouble? Contact us and we will help you

Yes No

How do I block the Opt-In Prompt from appearing in the inside page of the website? #

First click ‘Websites’, then ‘View Websites’ on the left hand side of the dash board.

Click ‘Edit’ next to your website.

Click on the ‘Prompt Management’ tab.

Once you are here click the ‘Add Condition’ Button.

Then paste the link that you are trying to apply the exclusion to in the ‘Page URL’ section.

Pick the prompt that is currently active on your site (custom or default) and set the ‘Auto Prompt’ tab to ‘False’

Now set the Priority to a higher number than your other conditions that you have.

And that’s it!

Now the condition is active and your Opt-In prompt will not be displayed on the pages that you have chosen.

Yes No

Can I delay how long it takes for my Opt-In Prompt to display? #

Yes it is possible,

First you would need to set the auto prompt to ‘False’.

Do this by going to ‘View Websites’ on the left hand side of the dashboard.

Then click ‘Edit’ next to your website.

Then click the ‘Prompt Management’ tab.

Click ‘Edit’

Then change the ‘Auto Prompt’ drop to ‘False’

Next there is just a small script you have to add to your site:

<script>
//show prompt after 3 seconds
function _pushReady(){
setTimeout(function(){ _pushPrompt() }, 3000);
}
</script>

Paste that at the bottom of your site, just below the </body> tag.

You can change “3000” to “4000” if you wanted to do 4 seconds. As example.

Yes No

Is there a way to customize the prompt so that is is bigger and say centered on the page? #

Yes we do allow you to do some additional customization to your opt-in prompt.

Here is a link where you can find out which CSS elements are used

Alternatively you can trigger the opt-in prompt with an image or a link, which we have documented here as well

 

Yes No

Creating a Manual Campaign #

In this document we are going to show you how to create a new web push notification campaign. Let’s get started.

STEPS

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Notifications’ located in the navigation bar on the left hand side of the screen. Selecting ‘Notifications’ will open a small drop down window with four options- ‘Manual Notifications’, ‘Triggered Notifications’, ‘Welcome Notifications’, and ‘RSS Notifications.’ Select ‘Manual Notifications.’

Selecting ‘Manual Notifications’ will bring you to your Campaigns page for all of your manual campaigns. If you have not created one before, this area will be empty. Click the link that says ‘Click here to create your first campaign.’

This will bring you to a screen asking you to name your campaign. Type in the name you want and select ‘Create Campaign’ at the bottom right of the screen. The next screen has all of your customization options for your campaign. The ‘Content’ tab will be highlighted and is the area where you input the body of your message along with the addition fields you want displayed.

The informational fields include: Name, Title, Icon, Image, Body, and Destination URL.

Here is a description of what each field will indicate:

Name: This will be the name of your campaign for your own reference, i.e. Summer Sale, West Coast Shoppers.

Title: This is the headline of your notification, the first line of text that your subscribers will see.

Body – This is the description of your notification, the main and largest part of your notification which goes into more detail of the headline.

Icon – A square image displayed next to your notification. This will grab your site icon by default but can be customized per push.

Image – An optional rectangular image displayed under your notification. Available on Chrome only.

Destination URL – This is where you would input the website link that your subscribers will be taken to when they click on your notification.

Example:

When you have input this information, select the ‘Recipients’ tab to determine who will receive this notification. From this tab you will select which segment (or segments) you wish to include. You may want this notification to go to all of your subscribers, or you may choose a particular segment of individuals.

Notes:

If users are part of multiple segments, they will only receive one notification.

After determining who will receive the notifications, it is time to set up the schedule. Select the third tab, titled ‘Schedule.’ You may wish to only send this notification once, or you can choose to have the notification repeat either daily, weekly, or monthly. First select the date and time you want the initial notification to be sent, and then select the automation schedule.

That’s it! Select ‘Schedule Push’ at the bottom of the page and your campaign will be created and will send at the specified time.

DRAFT & SCHEDULE

Campaigns may be saved as drafts and edited at a later time or marked as scheduled. Please note that scheduled notifications will be locked once the schedule date is reached, as they will begin spooling.

RESULTS

To view the results of a campaign head to “Push Notifications” -> “View Campaigns” and then find your campaign in the list. Once you have found the desired campaign click “View Results”. The results page allows you to breakdown the notification based on date and an optional segment. Segments are also great way to help measure conversions.

Note

For more details on how to track conversions, click here

If you’d like to see how push notifications look on their respective browsers, click here

 

Yes No

Creating a Triggered Push Campaign #

Triggered notifications are notifications that go out automatically after a certain event has occurred. We can also add custom events (view more).

In this document we are going to show you how to add triggered notifications into your web push notifications. These notifications are triggered when a user triggers a certain event. Let’s get started.

Steps

Start off by logging into your unifiedps account and opening your dashboard. From there, click on ‘Notifications’ located in the navigation bar on the left side of the screen. Selecting ‘Notifications’ will open a small drop down window with two options- ‘Manual Notifications’ and ‘Triggered Notifications.’ Select ‘Triggered Notifications.’

Selecting ‘Triggered Notifications’ will take you to your Campaigns page for all of your triggered campaigns. If you installed our software via one of our 3rd party plugins you may have some sample campaigns already prepared for you. For instance, Shopify users will see two campaigns – one for ‘Item Shipped’ and one for ‘Abandoned Cart.’ These are two popular examples of triggered campaigns you may wish to set up for your website.

If you didn’t install via one of our plugins you can still create new custom triggered notifications. Just skip ahead a bit in this document.

If you wish to set up one of these campaigns, select edit. This will bring up all of the customization options for that triggered notification. You may change the name of the campaign, the title, body, and destination URL. A preview will also display how your push notification will look.

Larger Image Example:

After you set up the content for your notification, click the ‘Trigger’ tab to open the customization options for what will trigger the notification. In the ‘Item Shipped’ campaign, for example, the event category is the item, and the event action is that the item has shipped. For the ‘Abandoned Cart’ campaign, the event category would be the cart, and the event action is that the cart has been abandoned. These triggers are automatically loaded in for you.

Finally, you can select the ‘Delay’ tab to customize how quickly you want your notification to be sent once a user triggers the specified action. For example, the pre-set delay for the ‘Item Shipped’ campaign is 0.5. This means that a user will be notified via push notification 30 seconds after their item has shipped. You may change this time if you like.

If you wish to set up another triggered notification, return to the main triggered campaign page and select the ‘New Triggered Notification’ button. This will allow you to set up a new triggered campaign for a separate user action.

Once you select ‘New Triggered Notification’ you will begin setting up the campaign. Start by naming your campaign. Enter a name and click ‘Create Campaign.’

Once you hit ‘Create Campaign’ you will enter the same customization window that you saw for the previous campaigns. Enter your title, body, and destination URL based on this new campaign. These fields will not be filled in with text like the two sample campaigns.

Select the ‘Trigger’ tab to specify your category and action. In this example, let’s say you were tracking all users who downloaded a free PDF on your site. In this case, the category is “Downloaded” and action is “Success PDF”.

Finally, select the ‘Delay’ tab to determine when the notification should be sent. The delay is measured in minutes, so if you want to send a notification to this visitor who downloaded the free pdf after about 10 minutes, set the number to 5.

When you are finished, you may either save the campaign as a draft or activate it right away by selecting the appropriate button at the bottom of the page (you may also choose to delete the campaign if you wish).

That’s it! Your new triggered notification will display along with all of your other triggered campaigns.

Yes No

Creating RSS Feed Campaigns #

1. Determine the RSS feed

We support nearly all RSS feeds. Below are some popular examples to help you get started.

 

Be sure to replace the word in ALL CAPS with your information. For example:

WordPress: https://blog.kissmetrics.com/feed/

Tip: Although these are the most common for the mentioned platforms, they may not always be the case. If the above does not work, try heading to your blog page and right clicking -> view source. On the source page search for “.rss” , “.xml” or “.atom” and try that link. If you still have no luck, try contacting our support team for assistance.

2. Add your RSS Feed To the push portal

After you’ve found your RSS feed, log into your UnifiedPS push dashboard and head to Notifications > RSS Notifications. Click “ New RSS Notification” and enter a name for your RSS Notification Campaign.

On the following page you’ll see a spot where you can add your RSS feed link. Paste it in and then generate the preview with the refresh link. If you have a proper link you’ll see your last few blog posts in the preview box. If not, head back to step 1 and track down the correct link.

3. Set the Push Notification Information

Click the “content” tab in the navigation which will show you a preview of your push notification.

By default you will see the fields filled out with things like {rss_title}, {rss_body} and {rss_link}. These are variables that will automatically be pulled from your RSS Feed. You can keep them as is, replace them with static text, or combine the two.

For instance you could set the title to be: New Post: {rss_title}.

Tip:

You can click “send test push” to see what the push will look like with these variables filled in. This feature is available on Chrome and Firefox only.*

4. Choose Your Recipients

Much like manual push notification campaigns, RSS campaigns can be directed to any segment you’d like. You may select as many segments as you want, but must at least set 1 in order to activate the campaign.

For instance, you could create a segment that targets anyone who has been your site and visited the blog specifically and have updated posts go just to them, since they’ve shown interest.

5. Enable and Save

Activate the push campaign by clicking the toggle at the top next to “Status”. Then hit save.

Push notifications will then automatically go out anytime the RSS feed is updated.

Please note that these notifications may not go out the exact second you publish a post and may take up to 30 minutes to be sent out. Our system will automatically learn how often you post and adjust accordingly for optimal send times.

Yes No

Creating Welcome Push Notification Campaigns #

In this document we are going to show you how to set up a welcome notification that will be sent to each new subscriber to your website. Let’s get started.

STEPS

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Notifications’ located in the navigation bar on the left side of the screen. Selecting ‘Notifications’ will open a small drop down window with four options- ‘Manual Notifications’, ‘Triggered Notifications’ ‘Welcome Notifications’ and ‘RSS Notifications.’ Select ‘Welcome Notification.’

Selecting ‘Welcome Notification’ will bring you to a screen where you will set up your welcome notification. Input the info requested (title, body, and destination URL).

That’s it! Now click the ‘Status’ toggle on the top right to enable the campaign and then hit ‘Save’ at the bottom of the page. Your welcome push notification will start sending immediately to each new visitor that agrees to be sent your push notifications.

Yes No

Sending Test Push Notifications #

Sometimes you may find the need to send yourself a test push notification before sending it out to your subscribers. Perhaps you are testing variables in your push, a link or maybe you just want to see how your notification looks like to the subscriber. Luckily, sending test notifications are very easy.

In order to send a notification to yourself, first you’ll need to track yourself down within the dashboard. The easiest way to do this is to view your website that has push notifications installed. If you have not previously opt-in to your site, be sure to click “Allow” at your notification prompt.

Next, head back to your dashboard and click “Logs” > “Pageview Logs”. Here you will find a breakdown of all pageviews from subscribers on your site. Try clicking the most recent “subscriber ID”, which will take you to an individual subscriber profile.

Pro Tip

If you receive a large amount of subscribers and find it hard to distinguish yourself simply by the basic pageview logs, try visiting a unique page on your site such as https://yoursite.com/hiddenpage or pass some get parameters to make it more unique (ie https://yoursite.com?randomtext)

Once on the subscriber profile, click “send test push”. Here you can specify any message you’d like to send to yourself.

Advanced Method:

Go to your website and open your developer console. Once there, type in “_pushSubscriberID” and it will return your subscriber ID. You can then insert this id here: https://dashboard.unifiedps.com/subscriber/YOURID

Yes No

Why did my push go out to fewer subscribers than expected? #

Generally your push notification “sent” count may be lower than the count of your target “segment” because of two reasons:

  1. Some of your notifications “bounced”. Essentially means that we were unable to deliver that notification to the subscriber – usually because they have unsubscribed. Our system will automatically attempt to deliver the notification several times if it fails and if it’s still unsuccessful, we will automatically remove that subscriber from your lists.

  2. You added your GCM/FCM keys incorrectly. If this is the case, contact us and we will make sure it’s all set up properly.

Yes No

Why are my manual notifications not being sent and are stuck on "scheduled." #

If you schedule your manual notifications for a specific time and that time passes but they don’t get sent out. Do they stay just “scheduled” or do they appear to get stuck in a “spooling” state?

If they stay “scheduled” double check that you are set with the correct timezone in your account settings. You can do that by following these steps .

We don’t automatically schedule ones that are too far in the past (to prevent people from accidentally scheduling it for the wrong day and causing it to go out instantly – which would be not what they hoped for)

Yes No

Creating a Segment #

In this document we are going to show you how to set up a segment. A segment is a group of people that you can send push notifications to. You can create a segment based on a variety of factors such as location or last time visiting your website. Let’s get started.

Steps

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Targeting’ located in the navigation bar on the left hand side of the screen. Selecting ‘Targeting’ will open a small drop down window with two options- ‘View Segments’ and ‘Add Segment.’ To start off, select ‘View Segments.’

Selecting ‘View Segments’ will pull up your existing list of segments. If you have not created any, you may notice some sample segments created for you. These should give you a good idea of the types of segments you can create.

For example, you can segment people based on if they purchase an item, viewed a specific page, or if they haven’t visited your website for a certain number of days.

You may select Edit to the right of any of the segments if you wish to use them. Or, if you want to create a new segment, select the blue ‘Create Segment’ button at the top right of the screen. This will open the ‘Add Segment’ page and is where you create your new segment.

There are 6 different options for creating a segment listed in the first tab. Page Views, Visit, Location, Campaign, Device Info and Custom Event. Simply select the tab for the section you wish to use for your segment and type in the necessary information.

For example, if you wish to create a segment for individuals who live in the state of California, select Region/ State under the Location section.

Input the information you want (in this case you would input ‘California’ in the Region category) and then click ‘Save Segment.’ You may input as many conditions as you want. This procedure works for any of the sections you choose. Simply click on a tab and input your desired conditions.

That’s it! Existing users who meet the criteria will instantly be added to the segment, and new users will automatically be included if they meet the given criteria.

Yes No

Understanding Custom Events #

Custom events allow users to add custom events to their subscribers to be used for segmentation and in turn targeted notifications.

PARTS TO AN EVENT

All events can have up to 4 different pieces of information, while only 2 are required. These are:

1.eventCategory – Required. (string or integer)
2.eventAction – Required (string or integer)
3.eventLabel – Optional. (string or integer)
4.eventValue – Optional. (integer)

HOW TO ADD AN EVENT.

Custom events can be added in two different ways:

1.Via Javascript API
2.Via REST API

ADDING CUSTOM ATTRIBUTES VIA JAVASCRIPT API

Once you have added your website and integrated the tracking code into your site, you are able to start adding custom events. To do so simply call the following snippet on your page, and replace the variables within the parameters with the information you want to track.

Note:

Note: eventCategory and eventAction are required fields while eventLabel and eventValue are optional. eventValue must be a numeric value.

  • HTML

Below is an example of tracking a custom event.

  • HTML

Note

If testing in the console, do not include _pushReady part and just paste the _pushTrackEvent portion.

The _pushReady part is a callback that runs everything inside after the page has fully loaded. It is best used if you paste that into the page itself rather than the console.

You may also tie an event to a link or button like this:

  • HTML

ADDING CUSTOM EVENTS VIA REST API

To add a custom event via a REST call check out our documentation here. Essentially you will just need to make an authenticated call and pass the custom event data like the example below. Read our API documentation for more information on responses and limitations.

  • HTML

VERIFYING EVENTS

To help in debugging event tracking, you can check out your logs under “Logs” -> “Event Logs” within your dashboard.

 

Yes No

Understanding Custom Attributes #

Custom attributes allow users to add custom information to their subscribers to be used for segmentation and in turn targeted notifications. Custom attributes can be added in two different ways:

  1. Via Javascript API
  2. Via REST API

ADDING CUSTOM ATTRIBUTES VIA JAVASCRIPT API (ON PAGE LOAD)

Once you have added your website and integrated the tracking code into your site, you are able to start adding custom attributes. To do so simply open up the tracking code you installed on your site and add the custom attributes within the “attributes” object.

Below is an example of adding the custom attribute “username” with a value of “djswan” as well as a custom attribute “age” with the value of “30”. When adding this code via the javascript API our software will automatically attach it to the subscriber who is visiting the page.

You may add as many attributes as you want to your account. The most recent attributes will override older ones, so if you mark “age”:30 and then later make the call “age”:”31″, the subscriber will now have “age” 31 on their account.

  • HTML

ADDING CUSTOM ATTRIBUTES VIA JAVASCRIPT API ( AFTER PAGE LOAD )

You may add a custom attribute the current subscriber at any point by calling the _unifiedpsTrackAttributes javascript function. Below is an example.

  • HTML

Note: adding the “_pushReady()” wrapper is optional but recommended. It essentially just ensures that the page has fully loaded before tracking the attribute.

ADDING CUSTOM ATTRIBUTES VIA REST API

To add the custom attributes via a REST call check out our documentation here. Essentially you will just need to make an authenticated call and pass the custom data like the example below. Read our API documentation for more information on responses and limitations.

  • HTML

VERIFYING ATTRIBUTES

To help in debugging event tracking, you can check out your logs under “Logs” -> “Attribute Logs” within your dashboard.

Yes No

Examples of Segments to Help You Get Started. #

Here is a list of commonly used segmentations to get you going.

Did Not Click On A Campaign

Set the left dropdown to “Manual Campaign Clicked ID”, middle dropdown to “IS NOT” and right dropdown to the campaign ID. You can find the campaign ID by clicking on the notifications drop down tab and finding your campaign. It will be under the row labeled “ID.”

Purchased Any Item.

Purchased A Particular Item.

Visited a Specific Page:

Set the left dropdown to “Visited Page URL”, middle dropdown to “IS” and right dropdown to the website URL.

Mobile Users:

Set the left dropdown to “Device Type (mobile/desktop)”, middle dropdown to “IS” and right dropdown to mobile.

Days Since Last Visit:

Set the left dropdown to “Days Since Last Visit”, middle dropdown to “Greater Than” and right dropdown to the number of days.

All Subscribers:

No need to set anything, just update or create the blank segment.

Location/ Geo-Location:

Set the left dropdown to “Region/State”, middle dropdown to “IS” and right dropdown to the State or Geo Location.

Clicked On A Campaign:

Set the left dropdown to “Manual Campaign Clicked ID”, middle dropdown to “IS” and right dropdown to the campaign ID. You can find the campaign ID by clicking on the notifications drop down tab and finding your campaign. It will be under the row labeled “ID.”

Yes No

Segmentation Options #

The following table serves as a rough representation of the segmentation conditions you can use with your subscriber data.

Name Example
Visited Page URL is, is not, contains, does not contain
Date of Last Visit is, is not
Days Since Last Visit less than, greater than
City is, is not, contains, does not contain
Region/State is, is not, contains, does not contain
Region/State Code is, is not, contains, does not contain
Country is, is not, contains, does not contain
Manual Campaign Clicked (ID) is, is not
Device Type (mobile/desktop) is, is not
Device Operating System is, is not, contains, does not contain
IP Address is, is not, contains, does not contain
Custom Attributes (Any) is, is not, contains, does not contain, greater than, less than
Event Category is, is not, contains, does not contain
Event Action is, is not, contains, does not contain
Event Label is, is not, contains, does not contain
Event Value is, is not, contains, does not contain
subscription_url* is, is not, contains, does not contain

*This will be the URL on which the person subscribed to your notifications.

Yes No

Viewing Campaign Results #

CAMPAIGN RESULTS

To view the results of a campaign head to “Push Notifications” -> “View Campaigns” and then find your campaign in the list. Once you have found the desired campaign click “View Results”.

Once on the results page, you will notice a quick preview of your notification, snapshots of total number of notifications sent, clicked and conversions.

You’ll also be able to view additional insights on your campaign such as daily notification sent breakdown, campaign details (ie links, segments, etc) and conversions that resulted directly from your push. Please note that conversion tracking is currently only available for our “Basic” and above plans.

Yes No

Data collected for subscribers #

The following table serves as a rough representation of the default data that is collected about your subscribers. You can also track custom events or attributes using the javascript or rest API

Any combination of the data collected can be used to create segments (groups of users).

Name Device Type Browser Name Browser Language Operating System Code IP Address Region Region Code City Postal Country Page (view) subscription_url
Example Desktop Chrome en-US Windows 75.39.32.218 Michigan MI Bloomfield Hills 48302 United States https://website.com/page https://website.com/page2

 

Yes No

Tracking Abandoned Carts #

In this document we are going to show you how to track abandoned shopping carts as custom events, which can then be used to triggered automated notifications to recover them.

 

STEPS

Step 1

The first step is to add the following snippet on your “Cart” or “Checkout” page. Please this just below your closing “</body>” tag.

  • HTML

In this example a cart is deemed abandoned if the user does not complete it in 30 minutes. You can change that to any number you want (60 = 60 minutes, 120 = 2 hours, etc)

Step 2

Next, place the following code on your “order complete” or “thank you” page.

  • HTML

Step 3

After you add those you will start seeing “Abandoned Cart” events start showing up in your event logs and you can create the triggered campaign to send notifications those who trigger it. It’s usually easiest to let the code run for 24 hours so that you can easily see the events being logged in your dashboard (“Logs” > “Event Logs”). Once you are ready you may proceed to adding custom event triggered notifications.

Yes No

Can I Import Subscribers From Another Push Vendor? #

Yes. Although it’s worth noting that unlike email or text message subscribers, website push notification importing is a little more complex.

Given the way website push notifications work, your previous website push subscribers will fall into one of three categories:

Scenario #1: You supplied custom GCM/FCM keys to your push notification provider.

In this scenario, you created your own Google GCM/FCM project and provided the push provider with your credentials. This is the ideal scenario as it gives you full flexibility for importing/exporting subscribers. In order to import subscribers to unifiedps, simply email your push notification provider for an export of your subscribers and email us as support@unifiedps.com with this list. Once we’ve imported your list, you can add your GCM/FCM keys to your unifiedps dashboard and you’ll be all set to go.

Scenario #2: You never supplied GCM/FCM keys, but your website push subscribers subscribed to yourwebsite.com (as opposed to yourwebsite.pushvendor.com)

In this case, we won’t be able to directly import your subscribers – even if you asked for an export of them from your other vendor. That’s because we don’t have access to the GCM/FCM key that serves as a permissions key to send notifications to subscribers.

The good news is though, that since your subscribers subscribed directly to yourwebsite.com, they will be instantly added to your unifiedps account the next time they visit your website. Since they previously gave permission to your website to market to them, they will not need to go through the opt-in process again.

Scenario #3: You never supplied GCM/FCM keys, and your website push subscribers subscribed to yourwebsite.pushvendor.com (as opposed to yourwebsite.com)

Unfortunately, this scenario makes it nearly impossible to import subscribers. Not only do you not have the GCM/FCM key which is required to reach your subscribers, but they also technically never subscribed to your website. As such, you’ve fallen into a severe vendor lock-in and would have to start from scratch if you ever wanted to move vendors (ouch!)

Yes No

(Basic) Can I Export My Subscribers? #

Yes you can export your subscribers!

In order to do this, first make sure you have pop-ups enabled.

Now just go to your dashboard and on the left hand side click on ‘Subscribers’ then ‘View Subscribers’

Once you are at this page, click on the ‘Options’ tab located underneath the blue ‘Add Segment Filter’ button. Then click on ‘Export (All)’

You will then be prompted that your subscribers are exporting. Just wait for a little bit because this can sometimes take a few minutes. If it seems to be taking an abnormal amount of time to export, please contact support.

Your subscribers will now download into a csv file and you’re all set!

If you’re looking for a full export including subscriber push tokens, then check out our other article for advanced exporting found here.

Yes No

(Advanced) Can I Export My Subscribers? #

Note: This document is If you’re looking for a full export including subscriber push tokens.

If you would like to get a basic subscriber export on your own (subscribers by city, state, country, os, device, etc.)

Then follow the steps found in this document here:

Generally speaking, website push notification subscribers have two aspects to them, their “device token” and a corresponding “key”. You need both parts not only to send notifications to subscribers, but to export them as well.

As a result, you will only be able to export your website push notification subscribers if you have added your own custom GCM/FCM Keys. You can read more on how to do that here.

What is “GCM” or “FCM”?

Google Cloud Messaging (commonly referred to as GCM) is a mobile notification service developed by Google that enables third-party application developers to send push notifications. In 2016 GCM has been superseded by Google’s Firebase Cloud Messaging (FCM).

If you’ve already added your GCM/FCM keys, then you can email support@unifiedps.com and we will provide you a full export of your subscribers. Please note that you will only be able to export those subscribers you gained since adding your custom GCM/FCM keys.

If you haven’t added your GCM/FCM keys but want to export your subscribers, you’re still partially in luck.

Unlike many other push notification service providers, unifiedps makes it so your website visitors subscribe directly to your website (ie yoursite.com instead of yoursite.unifiedps.com). This means that subscribers have already given your website permission and can automatically be opted back in when revisiting your site without showing them the push opt-in prompt.

Yes No

Leveraging Team Members #

Leveraging Team Members

In this document we are going to show you how you can add team members to your unifiedps account.

Steps

Adding a team member gives them the ability to send notifications on your behalf.
By default, team members do not have access to view all of your sites. In order to share website access, head to your dashboard and click ‘Websites’ and then ‘View Websites.’

Clicking ‘View Websites’ will pull up a list of all the websites you have added to your unifiedps account. Click ‘Edit’ next to the website you wish to add a team member to.

Once you click ‘Edit,’ click the ‘User Management’ tab at the top of the page. All current members for this website will be listed. To add a new member, click ‘Add User’ at the bottom of the page. Simply type in their email address and click ‘Invite User’.

Once you add a team member, they will instantly receive an email with login details.

With this system, you have control over which team members have access to which website of yours. Simply repeat this process for each website in order to add the team members you want to each website of yours.

Additionally, you may click ‘Settings’ on the dashboard and then click ‘My Team’ to pull up a list of all your current team members. You can click ‘Edit Permissions’ next to any team member to determine which websites they currently have access to.

Simply check or uncheck the box next to a website that you want that team member to have (or not have) access to and then click ‘Save Permissions.’

Note:

If a team member updates their account to a paid account, they have the ability to create their own team and as such will be automatically removed from yours. They will still be able to access any websites that you have shared with them.

If you need help with adding team members, take a look at our documentation here.

Yes No

Adding Team Members #

In this document we will show you how to add users to your UnifiedPS push account.

Steps

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Settings’ located in the navigation bar on the left side of the screen. Selecting ‘Settings’ will open a small drop down window with four options- ‘My Account,’ ‘My Team,’ ‘Plans & Billing,’ and ‘API Key.’ Select ‘My Team.’

The next screen will prompt you that you haven’t created your team yet. Click the link where it says ‘Click here to create your team.’

The next screen is your list of team members. You will be listed as the only team member, and under the ‘Type’ category you are listed as the owner. Click the ‘Add Team Member’ button at the top to add someone new to your team.

On the next screen, enter in the info for your new team member. Input their first and last name, as well as their valid email address that they will use to gain access to your account. You will also provide them with a temporary password that they can change once they gain access to your account. Select whether or not you want to notify the user by email and click ‘Create Member.’

That’s it! The user will be notified by email if you selected to (recommended) and will be provided their login information and a link to click to activate their account.

If you have multiple websites under your unifiedps account you can decide which team members have access to which websites. Team members may have access to just one, multiple, or all of your websites. From your ‘My Team’ dashboard (from your Dashboard select ‘Settings’ and then ‘My Team’), selecting ‘Edit Permissions’ for a particular team member will pull up a list of your websites.

Click the checkbox next to each websites that you want that particular team member to have access to. Click ‘Save Permissions’ when you are finished. Note: users are not notified when you make these changes.

Yes No

Sharing Access with Non Team Members #

In this document we will show you how to share your web push notifications with users who are not part of your team.

Steps

Start off by logging into your UnifiedPS push account and opening your dashboard. From there, click on ‘Websites’ located in the navigation bar on the left side of the screen. Selecting ‘Websites’ will open a small drop down window with two options- ‘View Websites’ and ‘Add Website.’ Select ‘View Websites.’

The next screen will show a list of your websites (you may have just one). Next to the website you want to share your web push notifications for, select ‘Edit.’

The next screen will have 5 tabs at the top. Select the ‘User Management’ tab. Under this tab you may add users who are able to view your site. Keep in mind these are not team members and so they will not be able to manage or make any changes, but only are able to view your site.

If you wish to add a new user, select the ‘Add User’ button at the bottom of the page.

Note

Users have to already have an unifiedps account, but do not have to be members of your team.

Enter the email address for the user you want to invite. Click ‘Invite User.’ That’s it! That user will now have access to your site.

Yes No

Using Variables in Notifications (Attributes) #

There are two types of ways you can pass variables into your notifications with Custom Attributes or Event Values.

This document walks you through an example of using custom attributes as variables in your notifications.

If you are looking to see how to pass custom event values into your notifications, please check here.

Generally speaking, most notifications that are sent to users are static. For instance, you may send a web notification to users such as:

Title: Happy Easter
Message: Save $50 off any order over $100
Linkhttps://yoursite.com

However, sometimes you may want to send notifications that are more dynamic in nature. Perhaps you want to address the user by their name or append an additional field within the url.

In order to use custom attributes within push notifications, simply use the following anywhere in your title, body or link of your push notification: {custom_attribute:ATTRIBUTE|FALLBACK}

For instance, let’s say we’ve been tracking the custom attribute “username” as well as the individual’s unique id (in this case known as objectId). So we could schedule a push notification campaign that would be set up like this:

Title: Hey {custom_attribute:username|there}
Body: You’ve got five new broadcasts to check out. Click to view them now!
Linkhttps://hangwith.com?userid={custom_attribute:objectId}

When the notification is sent out it will replace the individuals username if it exists. If there is no username, it will fallback and say “Hey there”. Fallbacks are completely optional. The link, for instance, will simply be empty if there is no objectId.

Advanced Tip:

You can also pass the subscriber uid by calling {custom_attribute:subscriber_uid}

Custom attributes within notifications are supported anywhere (event based notifications, api, manual, triggered, etc).

For easy testing, we recommend tracking yourself down within your subscribers list and sending a few test notifications to yourself first.

Yes No

Using Variables in Notifications (Events) #

There are two types of ways you can pass variables into your notifications with Custom Attributes or Event Values.

This document walks you through an example of using event values as variables in your notifications. In particular, this document will use an event label ({event_label}) as a variable but you can also use {event_category}, {event_action} or {event_value}

If you are looking to see how to pass custom attributes into your notifications, please check here.

Example

In this example we will guide you through adding order information into an event triggered campaign.

You can pass any custom event parameter (ie. “order number” or “tracking number” or “link the customer to their order status/tracking page”) into your ‘Triggered notification’

Below is an example of an item shipped triggered notification.

When looking at the destination URL, it says: {event_label}

Whatever is in the parameter brackets with be replaced with the event label that is attached to that event trigger.

So, in this case you can see that the ‘Event Label’ for item shipped is the link to a “thank you for your purchase of these items” tracking status page.

As a result, if you put {event_label} in those brackets for the destination URL, {event_label} will be replaced with the Event label attached to that trigger, in this case, a tracking link.

 

Yes No

Enabling Persistent Notifications #

As of December 2016, all sites automatically have persistent notifications enabled. If this is something you do not wish to have, contact us.

By default, web notifications on most browsers are dismissed automatically after 20-30 seconds on Desktop and remain visible until dismissed on mobile.

In this document we are going to show you how to enable persistent notifications on Desktop devices – meaning your notifications will remain visible until manually dismissed by the subscriber.

STEPS

Start off by downloading the updated “push-worker.js” file which contains the logic for persistent notifications. This is available here: Persistent Notifications Worker File

Now you simply need to replace the existing “unifiedps-worker.js” file that you previously uploaded to your website when integrating UnifiedPS push with the new one. This file should exist at https://YOURSITE.com/push-worker.js. If it does not, please stop here and contact support@unifiedps.com for further assistance.

That’s it. After you’ve uploaded/replaced that file your all new subscribers will now receive persistent notifications. Existing subscribers will also start receiving persistent notifications – it may just take a couple days to take full effect.

Yes No

Triggering Javascript After Prompt Approval/Denial #

With the UnifiedPS push Javascript API it’s easy to trigger some custom Javascript after your website visitor either approves or denies your request for push notifications.

Scenario 1 – Visitor approves the subscription prompt.

If a visitor approves the push notification prompt, the function _unifiedpsPermissionGranted() is called. So, in order to execute some javascript after the visitor grants permissions, set up something like this on your website:

  • JavaScript

Scenario 2 – Visitor denies the subscription prompt.

If a visitor denies the push notification prompt, the function _unifiedpsPermissionDenied() is called. So, in order to execute some javascript after the visitor denies permissions, set up something like this on your website:

  • JavaScript
Yes No

Conversion Tracking #

GETTING STARTED WITH CONVERSION TRACKING

UnifiedPS’ push built in conversion tracking allows you to easily see how your push notification campaigns are performing beyond the traditional “sent” and “clicked” measurements.

With conversion tracking, you specify a custom event that will serve as the conversion/goal.

Conversions are based off custom events. For Shopify users, we automatically track several events for you.

Steps

First off, head to your dashboard and click ‘Notifications’, and then click ‘Manual Notifications.’ You can set up conversion tracking for any new manual campaign that you create.

From the Campaigns window click ‘New Campaign’ to get started. Give the campaign a name and click ‘Create Campaign.’

Notice at the top a tab labeled ‘Conversions.’ Clicking here will allow you to turn on conversion tracking for this campaign. You have the option to turn it on or leave it off. Clicking to turn it on will track your conversions based on the event that you determine.

Note:

Make sure to click ‘On’ in order to activate Conversion Tracking.

With conversion tracking turned on, you must fill in the boxes for your event category and event action. You have the ability to set any custom event to define the conversion.

Example: Item Purchased

A popular example is for items purchased.

For Shopify users, we automatically track this event for you so it’s a great way to get set up instantly. If you decide a user purchasing any item counts as a conversion, you would set your Event Category as: Item and your Event Action as: Purchased. As you type these in, the boxes should help autofill for you.

When you are satisfied with your campaign and the conversion tracking you have set up, click ‘Schedule Push.’ Once the campaign has been sent, you can begin to track the conversion results. Heading back to your list of manual campaigns, you are able to see how many conversions there are for a given campaign by looking in the ‘Conversions’ column (far right column).

For a more detailed view, click ‘View Results’ next to any campaign. From that screen, click the ‘Conversions’ tab to see your conversions.

Here you will see a list of all of your conversions for the campaign you selected. The number of total conversions is also conveniently displayed at the top along with stats on how many notifications were sent and how many were clicked.

 

Yes No

How to Set Up Abandoned Shopping Cart Notifications #

Follow the following steps to get set up

1. Add Snippet To Cart Page

Place the following snippet on your cart page. Here you can define how long (in minutes) before a cart is deemed abandoned from a visitor. In the example below, we determine that a cart is abandoned if it has not been completed within 30 minutes.

  • Add Snippet To Cart Page

2. Add Order Complete Snippet

Place the following snippet on your order complete/ thank you page.

  • Add Order Complete Snippet

3. Create The Triggered Notification

If any subscriber adds a product to your cart and does not complete the order within the time specified in step #1, an event “Abandoned Cart” will be triggered for that subscriber. You can view the “Event Logs” within the push Dashboard to see records of these events.

Now you will need to create a triggered notification to take action whenever this event occurs. Head to Notifications > Triggered Notifications and create a new triggered notification

Specify the push notification message you want to send to abandoned carts.

Specify the trigger for the notification. The category should be “Cart” and action shoud be “abandoned”.

Set an additional (optional) delay. In most cases this can be set to 0 since the delay is already being set in Step #1

Click activate and you’re all set! You can view the results of the campaign by going to Triggered Notifications and clicking “View Results” next to your campaign.

Yes No

Web Push Content Gating #

Gating content is generally referred to as the process of putting resources (e.g., white papers, case studies) behind a form or registration, requiring visitors to subscribe before granting them access to the resource.

With UnifiedPS push, you can easily create gated content to encourage visitors to subscribe to your push notifications. This article walks you through the basic steps of achieving that.

Step 1: Defining The Hidden Content

Start with defining what content you want to be shown to those who have granted permission, and those who have not. Below is a simple example of how that could be structured.

  • HTML

Step 2: Showing The Content Based On Permissions

Next, you’ll need to add some logic to show the content based on their current permissions. This is done via unifiedps javascript.

  • JavaScript

Step 3: Putting it all together

That’s it. You’ll just need to add those both to your page and you’re all set! So together it would look like this on your page.

  • HTML
Yes No

Trigger Phone Call From Notifications #

If you want your push notification to be able to open up a phone call. You would just need to redirect them to a page which then does that logic. To make things easy, we’ve set up a page to handle this or you.

You can use this link: https://call.unifiedps.com/phone?number=4151234567 just replace the phone number in this example with your own and you are all set!

Here is what a phone call notification will look like:

Yes No

Chrome (Desktop) #

To manually change permissions, click the icon next to your website URL in the address bar. This is usually either an icon of a page or a lock. Once you click this, click the permissions tab and then if you have defined permissions for this website you will see a section which says “Notifications”.

If you click where it says ‘Allow’, you will be given options on how to manage your notifications.

Yes No

Chrome (Mobile) #

To manually edit a websites push notification permissions, first head to the website on your device. Then, click on the “green lock” at the top left of your device, next to the URL.

Click “Site Settings”

Click “Notifications”

You will now be presented with your device’s permissions for this site. You can manually allow, deny or reset it here.

Yes No

Safari (Desktop) #

To manually change push notification permissions for a website in safari on OSX(mac) head to Safari > Preferences > Notifications within the computers primary navigation bar at the top of your screen. Once on this screen you can change a site’s permissions from approved <-> denied or remove it all together.

Yes No

Firefox (Desktop) #

To manually change permissions, click the icon next to your website URL in the address bar. This is usually either an icon of a page or a lock. Once you click this, you will see the permissions tab and “Receive Notifications” underneath it. It will say “Allow” if permissions are allowed but if you would like to remove notification permissions for the website then click the “X” next to “Allow” in order to deny permissions.

Yes No

Firefox (Mobile) #

To manually edit a websites push notification permissions, first head to the website on your device. Then, click on the “green lock” at the top left of your device, next to the URL.

Click “Edit Site Settings”

You will now be presented with your device’s permissions for this site. You can manually set notifications to be allowed always, or clear it here.

Yes No

Opera (Desktop) #

To manually change permissions for Opera, click on ‘Preferences’ at under the Opera drop down.

Once in ‘Preferences, click on the ‘Websites’ tab on the left hand side of the window.

Scroll down until you see ‘Notifications’

Once you’re here, click on ‘Manage Exceptions’

This will show all of the websites that have permission to send you push notifications. You can remove the permissions of a website by clicking the red ‘X’ near ‘Allow’

 
Yes No

Opera (Mobile) #

To manually edit a websites push notification permissions, first head to the website on your device. Then, click on the three dashes on the bottom right of your device, next to the home icon.

Once these options pop up, click on the “Gear” icon at the bottom of the page.

Click on “Site settings”

Click on “Notifications”

Find the website that you wish to change permissions on and click it.

You will now be presented with your device’s permissions for this site. You can clear and reset it here, if it is not already allowed.

Yes No

Unsubscribing From Web Push #

Web push is still a relatively new marketing channel and there is yet to be a universal standard for easy subscription management. For now, please refer to the following links to manually manage your website subscribers and/or unsubscribe from a website.

Note: Quick Unsubscribe Option

The majority of push notifications also have an additional “Settings” button/icon which, whien clicked, takes the subscriber to a page to manage all push subscriptions. Below is an example.

Wait, what is “web push” anyways?

“Web push” (also known as website push notifications or browser push notifications) are tiny messages (“push notifications”) that are delivered instantly to your desktop or mobile device after “subscribing” to a website.

It is not possible for a website to automatically opt you in for web push, so that means somewhere along the way you allowed notifications from them. The most common opt-in request comes from Chrome, which looks like the image below.

Example:

Yes No

(API) Generic Functions #

_pushCheckPermissions()

Description: Checks visitor’s push notification permissions
Params: N/A
Response: (str) – granted, default or denied

_pushSupportsPush()

Description: Checks to see if visitor’s browser supports push notifications
Params: N/A
Response: (boolean)

_pushGetSubscriberID()

Description: Grabs the active visitor’s subscriber id. If none exists, one is generated.
Params: N/A
Response: promise, (str) subscriber id

  • JavaScript

_pushGetPushToken()

Description: Pulls the device push token from the current visitor. This is delivered as a javascript promise.
Params: N/A
Response: promise, (str) device token

  • JavaScript

_pushTrackEvent(category, action, opt_label, opt_value)

Description: Tracks a custom event to current subscriber
Params:

  • category – required. category of event
  • action – required. action of event
  • opt_label – optional. custom label
  • opt_value – option. numeric value
    Response: promise, (obj)
  • JavaScript
  •  Response

_pushPrompt()

Description: If custom push prompt exists, show it, else load native push prompt
Params: N/A
Response: N/A

_pushGetSubscriberIDFromToken(token)

Description: Grabs visitors subscriber id based on push token
Params:

  • token – required. browser push token
    Response: promise, (obj) result, uid
  • JavaScript

_pushTrackAttributes(attributes)

Description: Grabs visitors subscriber id based on push token
Params:

  • attributes – required. object. can be any number of attributes.
    Response: promise, (obj) result, message
    Notes: Duplicate attribute records are not inserted.
  • JavaScript
  •  Response

_pushRunNative()

Description: Launches native push notification prompt
Params: N/A
Response: N/A

 

Yes No

(API) Callback Functions #

(API) Callback Functions

 

_pushReady()

Description: Called when push script has finished loading.

_pushPermissionGranted()

Description: Called after website visitor has granted push notification permissions.

_pushPermissionDenied()

Description: Called after website visitor has granted denied notification permissions.

Yes No

REST - LOGIN #

Yes No

(API) Get User #

https://api.unifiedps.com/prod/login
  • cURL
  •  200 OK

BODY PARAMS

username

string
REQUIRED

Username

password

string
REQUIRED

Password

 

SUGGEST EDITS

(API) Get User

gethttps://api.unifiedps.com/prod/user/

 200 OK 401 Unauthorized

Yes No

(API) Update User #

https://api.unifiedps.com/prod/user/
 
 
 200 OK 401 Unauthorized 400 Bad Request

BODY PARAMS

 
first_name

string

First Name

last_name

string

Last Name

password

string

Password

timezone

string

Timezone

 

Only allowed to update definition and name updates.

Definition must follow the format below

Yes No

(API) Get All Websites #

https://api.unifiedps.com/prod/sites/
 
 
 200 OK 401 Unauthorized

QUERY PARAMS

 
limit

string

Number of results

skip

string

Skip

 
 
Yes No

(API) Get Website Code #

https://api.unifiedps.com/prod/site/code/id
 
 
 200 OK 401 Unauthorized

PATH PARAMS

 
id

string
REQUIRED

Site ID

 
 
Yes No

(API) Add Website #

https://api.unifiedps.com/prod/sites/
 
 
 200 OK 400 Bad Request

BODY PARAMS

 
url

string
REQUIRED

Website URL

name

string
REQUIRED

Name of Website

 
 
Yes No

(API) Update Website Name #

https://api.unifiedps.com/prod/site/id
 
 
 200 OK 401 Unauthorized 400 Bad Request

PATH PARAMS

 
id

string
REQUIRED

Site ID

BODY PARAMS

 
name

string

Website Name

 

Only allowed to update definition and name updates.

Definition must follow the format below

Yes No

(API) Update Website Icon #

https://api.unifiedps.com/site/icon/id
 
 
 200 OK 401 Unauthorized 400 Bad Request

PATH PARAMS

 
id

string
REQUIRED

Site ID

BODY PARAMS

 
icon

file

Icon

 
 
 
Yes No

(API) Update Website Push Package (Safari) #

https://api.unifiedps.com/prod/push/package/id
 
 
 200 OK 401 Unauthorized 400 Bad Request

PATH PARAMS

 
id

string
REQUIRED

Site ID

 

Only allowed to update definition and name updates.

Definition must follow the format below

Yes No

(API) Delete Website #

https://api.unifiedps.com/prod/site/id
 
 
 200 OK 401 Unauthorized

PATH PARAMS

 
id

string
REQUIRED

Site ID

 

Only allowed to update definition and name updates.

Definition must follow the format below

Yes No

REST - ATTRIBUTES #

Yes No

(API) Get Custom Attributes #

https://api.unifiedps.com/prod/attributes/id
 
 
 200 OK 401 Unauthorized

PATH PARAMS

 
id

string
REQUIRED

Site ID

 
 
Yes No

(API) Get Subscriber #

https://api.unifiedps.com/prod/subscriber/id
 
 
 200 OK 401 Unauthorized

PATH PARAMS

 
id

string
REQUIRED

Subscriber ID

 
 
Yes No

(API) Add Subscriber Attribute #

https://api.unifiedps.com/prod/subscriber/id
 
 
 200 OK 401 Unauthorized 400 Bad Request

PATH PARAMS

 
id

string
REQUIRED

Subscriber ID

BODY PARAMS

 
idSite

string

Site ID

owner_uid

string

Account ID

 

Only allowed to update definition and name updates.

Definition must follow the format below

Yes No

(API) Add Subscriber Event #

https://api.unifiedps.com/prod/subscriber/id/event