WonderPush Documentation

The WonderPush Developer Hub

Welcome to the WonderPush developer hub. You'll find comprehensive guides and documentation to help you start working with WonderPush as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Website Quickstart

How to set up WonderPush Web push notifications on your website

Setting up push notifications for your website is easy. Web push notifications are the ideal solution to re-engage users and bring them back to your website.

Estimated setup time: 15 minutes.

If you haven't already, sign up for a free account on wonderpush.com.

If you're not familiar with Web Push, see What are Web Push Notifications?.

This guide works for any website. Please note that we have specific instructions for WordPress, Wix, React, Google Tag Manager, Weebly, Blogger and Squarespace.

Before we start: create your project

Click on New Project:

Choose a name for your project and select Website as a platform then click Create:

Already have a project?

Just add the Website platform to any existing project by going to Settings, selecting the first tab named after your project and clicking Edit. You'll be presented a form that lets you add a platform.

Step 1. Fill-in website information

Choose Typical Site as your setup type, unless you're using WordPress, Wix, React, Google Tag Manager, Weebly, Blogger or Squarespace.

Then fill in your website information:

Site name
Enter the name of your website. This name might be displayed when users subscribe to push notifications.

Site URL
Enter the base URL of your site (e.g. https://example.com). This will be the default URL users will be redirected to when they click on a notification.
If your site is accessible from both www. and non-www. URLs (e.g. example.com and www.example.com) we recommend you redirect traffic to one of the URLs and use that to fill-in the URL field.

Enter Icon
Enter the URL to your website icon or choose a file from your computer. Your website icon will be displayed in notifications. It should be a square image file. Prefer HTTPS.

My site doesn't have HTTPS
If your site doesn't have HTTPS, check this box. Please note that HTTPS certificates are FREE these days, and very easy to install. Take a look at let's encrypt.

HTTPS is required for push notifications to work, and fortunately WonderPush can provide you with a free HTTPS enabled domain.

Choose an HTTPS notification domain.

About the push notification domain

Your push notification domain will be displayed in every notification you send:

In this example, the notification domain is mywebsite.by.wonderpush.com.
When users subscribe to push notifications, they grant your domain the permission to send them push notifications. When you change the push notification domain, users have to subscribe again!

For these reasons, it is especially important to choose the right push notification domain from the start.

Using your own domain
Recommended

This is the best option. It is only available for HTTPS websites. If your website does not support HTTPS, or if you can't upload SDK files, use .by.wonderpush.com.

Using a by.wonderpush.com subdomain

If your site does not support HTTPS, or if you can't upload SDK files, that's your only option.

Step 2. Configure subscription prompts

In this section, you can configure subscription prompts for your website. Subscription prompts are ready-made user-interfaces you can use to let users subscribe to push notifications.

To activate a subscription prompt, simply click the switch in front of its name so that it shows as ON. To customize it, click on Customize.

You can find out more about subscription prompts in our dedicated guide.

Hit Save.

Step 3. Copy code

Hit Save if you haven't already.

To enable WonderPush on your site, paste the code from your dashboard into every page of your website. If you do not have access to your site's code, get help from a developer.

Tip if you cannot add the top `<script … async>` tag

If you are restricted to writing JavaScript and cannot add the first script tag, simply use the following alternative snippet:

function(){
  var js = document.createElement('script');
  js.src = 'https://cdn.by.wonderpush.com/sdk/1.1/wonderpush-loader.min.js';
  js.async = true;
  document.head.appendNode(js);
}();

window.WonderPush = window.WonderPush || [];
WonderPush.push(["init", {
    webKey: "a6a00ccf60ffee04cb201cead4304fc4db8fa8e0a2823a77466e8c8ebeed4e25",
}]);

Step 4. Upload SDK files

Ignore if your push notification domain is a subdomain of `by.wonderpush.com`

Subdomains of by.wonderpush.com do not need any extra files. Skip to the next step.

  1. Download wonderpush-sdk-files.zip

  2. Unzip the archive and upload its content to the top-level root of your website directory to make it publicly accessible.

Once you've uploaded both files, the following URLs should be publicly accessible (replace example.com with your site domain):

  • https://example.com/wonderpush.min.html
  • https://example.com/wonderpush-worker-loader.min.js

If you cannot upload SDK files in the root directory, you have the option to put them in a subdirectory:

Receive your first push!

Head over to your website and refresh the page until you see the subscription dialog you've previously configured and click the positive button:

Wait a couple of minutes and receive the default welcome notification:

Congratulations, you're done!


What's Next

Customize your subscription prompt using one of our pre-made UIs. Set properties on users and send events using our Website SDK (javascript).

Subscription Prompts
Properties
Events
Website SDK

Website Quickstart


How to set up WonderPush Web push notifications on your website

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.