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    Discussions

Typical Setup

OneSignal Setup Guide for typical websites. Works with all Web Push platforms (Chrome, Firefox, Safari)

This guide will walk you through how to set up web push on a Typical Site. If you are using a website builder such as WordPress, Blogger, or Shopify, or wish to write Custom Code, please go to Web Push Quickstart.

Video Setup Guides!

For more visual people, we have created HTTP and HTTPS video setup guides:

HTTPS Typical Setup
HTTP Typical Setup
HTTPS WordPress Setup
HTTP WordPress Setup

HTTPS Typical Setup Video

HTTP Typical Setup Video


Step 1. Choose Integration

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


Step 2. Site Setup

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

Enter Site URL

This must be the exact URL you see in the browser when you visit the site.
Most users just enter their base site URL for this field (e.g. https://example.com).

If your site is accessible from both www & non-www links (e.g. hexample.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.

Auto Resubscribe

Recommended
This feature is only for HTTPS sites and you do not select "My site is not fully HTTPS".
This allows users to automatically resubscribe upon returning to the site without being prompted if they clear their browser cache or if you are transferring to OneSignal from another push provider.

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.

My Site is Not Fully 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. Permission Prompt Setup

To send push notifications to users, you first must ask them for permission using a Prompt. You must have at least one Prompt on your site for web push to work. Click Add a Prompt to open the permission prompt selector.

Permission Prompt Editor

In the Permission Prompt Editor, you can select which prompts you wish to use, and style them as you like. Once you have edited the prompt to your liking, click Save.

Prompt Type
Description

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

Native Prompt (HTTPS-only)

A small modal required by the browser to subscribe users to notifications. Must not have selected "My site is not fully HTTPS" to use this modal.

A modal presented before the Native Browser Prompt and asks if users are interested in signing up.

HTTP Pop-Up Prompt (HTTP-only)

A pop-up window that appears after other prompts that is required for HTTP sites.

A button or link which you can place anywhere on your pages and users can interact with to subscribe.

Step 4. 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 here.


Step 5. Advanced Options

Optional

Most sites will not have to edit anything in Advanced options. See Web Push Advanced Options to learn more about each option.


Step 6. Upload OneSignal SDK

HTTPS Only

This option will not be available if you selected 'My Site is Not Fully HTTPS'. Skip to the next step.

Next, you'll need to add the OneSignal SDK files to your site. To do so,

  1. Download the OneSignal SDK files. (You can also download the files here).

  2. Unzip the OneSignal SDK files. There should be two files:

    • https://yoursite.com/OneSignalSDKWorker.js
    • https://yoursite.com/OneSignalSDKUpdaterWorker.js
  3. Upload the OneSignal SDK files to the top-level root of your site directory, making them publicly accessible.

FAQ

How do I upload files?

There are three ways you can upload files to your site:

Option A: FTP
  • Use an FTP Server like FileZilla to upload the files to your root directory
  • Here is a great step-by-step guide.
Option B: Control Panel
  • Use your hosting provider's control panel like cPanel to upload files.
Option C: Contact your hosting provider
  • Most hosting providers will be more than happy to assist you in uploading files to your site.
  • Just send them the zip file above and ask them to unzip it in your site's root directory.

How can I tell if I've uploaded the files correctly?

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

  • https://yoursite.com/OneSignalSDKWorker.js
  • https://yoursite.com/OneSignalSDKUpdaterWorker.js

Can I host the OneSignal SDK myself?

Can these files be served from a subfolder of my site?


Step 7. Add Code to Site

To enable OneSignal on your site, you will need to paste the code from Web Push Settings into your website's <head>. If you do not have access to modify your site's code, you will need to contact a developer to help you.

You're Done!

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


Typical Setup


OneSignal Setup Guide for typical websites. Works with all Web Push platforms (Chrome, Firefox, Safari)

Suggested Edits are limited on API Reference Pages

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