OneSignal Help & Documentation

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

Get Started    Support

WordPress Setup

How to set up OneSignal Web Push notifications on WordPress sites

This guide will walk you through how to set up web push on WordPress. If you do not use WordPress, or wish to write custom code, please go to Web Push Quickstart. If you use WordPress VIP, please contact us to set up.

At any time to get back to setup, go to App Settings and click Configure for the Google Chrome platform (instructions for Safari are here).


Step 1. Choose Integration

OneSignal supports sending web push notifications from a variety of different web technologies. Select WordPress to continue:


Step 2. WordPress Site Setup

Once you've selected WordPress as your integration, you must fill out information about your site.

Enter Site URL

Most users just enter their base site URL for this field (e.g. yoursite.com).

If your site is accessible from both www & non-www links (e.g. example.com AND www.example.com), please only enter the URL that you wish to send push notifications from. We recommend redirect traffic from one to the other (e.g. users that visit example.com are redirected to www.example.com), so that all your traffic only goes to one.

Default Notification Icon URL

Enter a link to an icon file that is at least 80x80 pixels (Recommended size is 192x192). The file must be .png, .jpg, or .gif.

If WordPress.com hosts your site

WordPress-hosted implementations must use a label to send push notifications. Select My site is not fully HTTPS and choose a unique label (e.g. mylabel), which will be displayed as mylabel.os.tc.

If you self-host WordPress

If your site uses WordPress technology but is hosted on a hosting provider that is not WordPress, you will need to determine if your site fully supports HTTPS.

Web Push works best with sites that fully support HTTPS, and we recommend using HTTPS for Web Push when possible. To determine if your site fully supports HTTPS, look for the following:

  • Your site URL must begin with https://, and display a green lock icon on the browser's address bar
  • Your site must redirect all http:// requests to https:// requests. In other words, users accessing the site via HTTP will be redirected to the HTTPS version.

If your site does not fully support HTTPS, you should select 'My site is not fully HTTPS':

Once you've selected this, you will need to choose a unique label to be displayed in your notifications. For example, the below image shows notifications are coming from mylabel.os.tc:

Warning: You can only change your label if you have less than 100 web users. Once you have 100+ web users, this setting is disabled.

FAQ

How does OneSignal work differently with HTTP sites?

What if my site is in a subfolder?

Why does my site require a label?

Why can't I change my label?


Step 3. Install OneSignal WordPress Plugin

To enable OneSignal on your WordPress site, you will need to install the OneSignal WordPress Plugin.

Once you've installed the WordPress plugin, you'll need to copy your App ID and API Keys.

Paste these keys into your WordPress plugin Configure section in the appropriate inputs:

Be sure to Save your configuration once you've added these keys.


Step 4. Add Prompts in WordPress Plugin

Next, you'll want to configure your prompts in the OneSignal WordPress Plugin, so that users can subscribe to push notifications. You can do this in the Configure section of the plugin.

Subscription Bell

A small icon at the corner of your page that users can interact with to subscribe

Slide Prompt

A small modal that comes from the center of the page and asks if users are interested in signing up.

HTTP Pop-Up (HTTP-only) - a pop-up window that appears after other prompts that is required for HTTP sites.


Step 5. Welcome Notification

Optional

Welcome notifications an optional way to thank users after subscribing to your site. Users will see a welcome notification as soon as they subscribe. You can edit or disable them in the Configure section of your plugin.


You're Done!

Next step: Send your first push notification via the OneSignal Dashboard

WordPress Setup

How to set up OneSignal Web Push notifications on WordPress sites