Setup

You may notice the need to wrap your OneSignal calls with OneSignalDeferred.push(async function() { ... })

You can add as many methods into the function() as desired.

The OneSignal SDK is loaded with the defer attribute on your page. For example:

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>

This means the OneSignal code will execute after the HTML document has been fully parsed, preventing any blocking of the site by the OneSignal SDK. However, this presents a problem for page scripts that depend on the OneSignalDeferred variable existing. To resolve this, when you add OneSignal to your site, it should begin with:

window.OneSignalDeferred = window.OneSignalDeferred || [];

This creates a OneSignalDeferred variable, and if OneSignal is already loaded, it's then assigned to the loaded instance. Otherwise, the OneSignal variable equals an empty array - [].

All arrays have a .push() function, so at this point, the OneSignalDeferred variable is simply an array of functions we're pushing on to it. When the SDK finally loads, the SDK processes all the functions pushed so far and redefines .push().

init()

This should be called only once during application startup.

Call this from each page of your site to initialize OneSignal. This call is required before any other functions can be used.

window.OneSignalDeferred = window.OneSignalDeferred || [];
OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.init({
    appId: "YOUR ONESIGNAL APP ID",
  });
});

Init options are as follows. These only work with Custom Code Setup:

promptOptions parameters

Pass in these optional parameters within promptOptions when initializing to localize the prompts to your custom text and language. All entries are limited in length. Foreign characters accepted. Each parameter is optional, and its default is used when it is not included.

welcomeNotification parameters

Pass in these optional parameters within welcomeNotification when initializing to customize or disable the welcome notification sent to new site visitors. Any person visiting your site for their first time, or an existing user who has completely cleared their cache is considered a new site visitor.

notifyButton parameters

Pass in these optional parameters within notifyButton when initializing to enable and customize the Subscription Bell (formerly known as the notify button). All parameters below are optional. If not set, they will be replaced with their defaults.

The following is a basic template of how you would call init().

<script src="https://cdn.onesignal.com/sdks/web/v16/OneSignalSDK.page.js" defer></script>
<script>
window.OneSignalDeferred = window.OneSignalDeferred || [];
OneSignalDeferred.push(async function(OneSignal) {
  await OneSignal.init({
    appId: "99397374-10fe-4865-b62d-d8b71114b320",
    safari_web_id: "web.onesignal.auto.20f3ee95-6f21-4aad-a9bb-9c5899a4353a",
    notifyButton: {
      enable: true,
    },
    promptOptions: {
      slidedown: {
        prompts: [{
            type: "smsAndEmail",
            autoPrompt: false,
            text: {
              emailLabel: "Insert Email Address",
              smsLabel: "Insert Phone Number",
              acceptButton: "Submit",
              cancelButton: "No Thanks",
              actionMessage: "Receive the latest news, updates and offers as they happen.",
              updateMessage: "Update your push notification subscription preferences.",
              confirmMessage: "Thank You!",
              positiveUpdateButton: "Save Preferences",
              negativeUpdateButton: "Cancel",
            },
            delay: {
              pageViews: 1,
              timeDelay: 20
            },
          },
          {
            type: "category",
            autoPrompt: true,
            text: {
              actionMessage: "We'd like to show you notifications for the latest news and updates.",
              acceptButton: "Allow",
              cancelButton: "Cancel",

              /* CATEGORY SLIDEDOWN SPECIFIC TEXT */
              negativeUpdateButton: "Cancel",
              positiveUpdateButton: "Save Preferences",
              updateMessage: "Update your push notification subscription preferences.",
            },
            delay: {
              pageViews: 3,
              timeDelay: 20
            },
            categories: [{
                tag: "politics",
                label: "Politics"
              },
              {
                tag: "local_news",
                label: "Local News"
              },
              {
                tag: "world_news",
                label: "World News",
              },
              {
                tag: "culture",
                label: "Culture"
              },
            ]
          }
        ]
      }
    }
  });
});
</script>

User

When your users subscribe to push notifications on your website, OneSignal creates a User record (onesignal_id) and Subscription record (subscription_id). Users can have multiple subscription records which you identify as belonging to a specific user through the use of the login method which sets the external_id.

login()

The login method identifies a user by setting the external_id alias. Logging in a user with the OneSignal SDK will switch the context to that specific user.

• If the external_id exists, the user will be retrieved, and the context will be set from that user information. If operations have already been performed under a device-scoped user, they will not be applied to the now logged-in user, and their information will be lost.
• If the external_id does not exist, the user will be created, and the context will be set from the current local state. If operations have already been performed under a device-scoped user, those operations will be applied to the newly created user.

OneSignalDeferred.push(async function(OneSignal) {
   await OneSignal.login("external_id");
});

//Example combining with push subscription change event
function pushSubscriptionChangeListener(event) {
  if (event.current.token) {
    console.log(`The push subscription has received a token!`);
    //this is a good place to call OneSignal.login and pass in your user ID
    OneSignal.login("external_id");
  }
}
OneSignalDeferred.push(function(OneSignal) {
  OneSignal.User.PushSubscription.addEventListener("change", pushSubscriptionChangeListener);
});

logout()

Log out the user previously logged in via thelogin. The user property now references a new device-scoped user. A device-scoped user has no user identity that can later be retrieved, except through this device, as long as the app remains installed and the app data is not cleared.

OneSignalDeferred.push(async function(OneSignal) {
   await OneSignal.logout();
});

addAlias()

Set an alias for the current user. If the alias label exists on this user, it will be overwritten.

OneSignal.User.addAlias("ALIAS_LABEL", "ALIAS_ID");

addAliases()

Set aliases for the current user. If any alias labels exist on the user, they will be overwritten.

OneSignal.User.addAliases({
  ALIAS_LABEL_01: "ALIAS_ID_01",
  ALIAS_LABEL_02: "ALIAS_ID_02",
  ALIAS_LABEL_03: "ALIAS_ID_03", 
});

removeAlias()

Remove an alias from the current user.

OneSignal.User.removeAlias("ALIAS_LABEL");

removeAliases()

Remove aliases from the current user.

OneSignal.User.removeAliases(["ALIAS_LABEL_01", "ALIAS_LABEL_02", "ALIAS_LABEL_03"]);

externalId

Get the External ID of the currently logged-in user.

OneSignal.User.externalId

onesignalId

Get the OneSignal ID of the currently logged-in user.

OneSignal.User.onesignalId

addEventListener() User State

Detect when the user state changes, like when a OneSignal ID or External ID is created/changed.

OneSignalDeferred.push(function() {
  OneSignal.User.addEventListener('change', function (event) {
    console.log('change', { event });
  });
});

Data Tags

Data Tags are custom key : value pairs of string or number data you set on users based on events or user data of your choosing. For example, you can tag a user based on which message they engaged with, so later, you can create Segments or further Personalize Messages. See Data Tags Overview for more details on use cases.

addTag()

Add a tag for the current user. If the tag key already exists, it will be replaced with the value provided here. If you try to set more tags on a user than your plan allows, it will fail. You will need to delete any unwanted tags first before setting or updating tags. See Tags FAQ for details.

OneSignal.User.addTag('tag_key', 'tag_value');

addTags()

Add multiple tags for the current user. A tag key will be replaced with its corresponding value if it already exists. If you try to set more tags on a user than your plan allows, it will fail. You will need to delete any unwanted tags first before setting or updating tags. See Tags FAQ for details.

OneSignal.User.addTags({ 
 KEY_01: "VALUE_01",
 KEY_02: "VALUE_02",
 KEY_03: "VALUE_03"
});

removeTag()

Remove the data tag with the provided key from the current user.

OneSignal.User.removeTag("KEY");

removeTags()

Remove multiple tags from the current user.

OneSignal.User.removeTags(['KEY_01', 'KEY_02', 'KEY_03']);

getTags()

Requires SDK 5.0.5+

Loads the current user's local tags. Remote tags are pulled and stored locally when the user changes after calling login() or when a new session is started – your app is opened after over 30 seconds of being out-of-focus.

const tags = OneSignal.User.getTags()

Privacy

setConsentRequired()

Determines whether users must consent to privacy before sending their data to OneSignal. This should be set to true to ensure compliance before invoking the init method.

OneSignal.setConsentRequired(true);

setConsentGiven()

Sets whether privacy consent has been granted.

OneSignal.setConsentGiven(true);

Push Notifications

setDefaultUrl()

Sets the default URL for notifications.

If you haven't set a default URL, your notification will open to the root of your site by default.

OneSignal.Notifications.setDefaultUrl("https://onesignal.com");

To set the default URL for notifications, provide a valid URL that you want to be launched when the notification is clicked. This default URL will be used if no other URL is specified when creating a notification. If you do specify a URL when creating a notification, the default URL will be overridden.

In the case of Safari, the default notification icon URL will be set to the Site URL that you have specified in your Safari settings, as this function is not available.

setDefaultTitle()

Sets the default title to display on notifications.

OneSignal.Notifications.setDefaultTitle("Powered by OneSignal!");

If a notification is created with a title, the specified title always overrides this default title.

A notification's title defaults to the title of the page the user last visited. If your page titles vary between pages, this inconsistency can be undesirable. Call this to standardize page titles across notifications, as long as a notification title isn't specified.

isPushSupported()

Returns true if the current browser supports web push.

const isSupported = OneSignal.Notifications.isPushSupported();

permission

Determine whether your site has notification permission.

This returns true when your site has permission to display notifications.

• This is just the sites's permission, does not factor in OneSignal's optOut status or the existence of the Subscription ID and Push Token, see OneSignal.User.PushSubscription for these.

let permission = OneSignal.Notifications.permission;

If you're deleting your user entry on our online dashboard for testing, the SDK will not sync with our dashboard and so this method will still return true (because the browser itself remembers the site's permissions). Follow Clearing your cache and resetting push permissions to reset this in the browser itself.

requestPermission()

Requests push notifications permission via the native browser prompt.

Web SDK v15 see showNativePrompt method.

OneSignal.Notifications.requestPermission();

addEventListener() Push notification

You can hook into the notification life-cycle by attaching your event handlers to a notification event. Calling addEventListener lets you add an arbitrary number of event handlers for notification events.

function eventListener(event) {
  console.log(`${event}`);
}

OneSignal.Notifications.addEventListener("event", eventListener);

#foregroundWillDisplay

This event occurs before a notification is displayed. This event is fired on your page. If multiple browser tabs are open on your site, this event will be fired on all pages on which OneSignal is active.

function foregroundWillDisplayListener(event) {
  console.log(`notification will display: ${notification}`);
}

OneSignal.Notifications.addEventListener("foregroundWillDisplay", foregroundWillDisplayListener);

#dismiss

This event occurs when:

• A user purposely dismisses the notification without clicking the notification body or action buttons
• On Chrome on Android, a user dismisses all web push notifications (this event will be fired for each web push notification we show)
• A notification expires on its own and disappears

Note: This event does not occur if a user clicks on the notification body or one of the action buttons. That is considered a notification click (see the Click event above).

This event is fired on your page. If multiple browser tabs are open to your site, this event will be fired on all pages on which OneSignal is active.

function notificationDismissedListener(event) {
  console.log(`dismiss event: ${event}`);
}

OneSignal.Notifications.addEventListener("dismiss", notificationDismissedListener);

#permissionChange

This event occurs when the user clicks Allow or Block or dismisses the browser's native permission request.

function permissionChangeListener(permission) {
  if (permission) {
    console.log(`permission accepted!`);
  }
}

OneSignal.Notifications.addEventListener("permissionChange", permissionChangeListener);

#permissionPromptDisplay

This event occurs when the browser's native permission request has just been shown.

function promptListener() {
  console.log(`permission prompt dispslayed event: ${event}`);
}

OneSignal.Notifications.addEventListener("permissionPromptDisplay", promptListener);

#click

This event will fire when the notification's body/title or action buttons are clicked.

function clickEventListener(event) {
  console.log(`click event: ${event}`);
}

OneSignal.Notifications.addEventListener("click", clickEventListener);

removeEventListener() Push notification

Removes the event handler for the given event.

function eventListener(event) { // ... }

OneSignal.Notifications.removeEventListener("event", eventListener);

Slidedown Prompts

Display the OneSignal Slide Prompt on your sites. This type of prompt slides down from the top of the browser viewport on Desktop and up from the bottom on mobile devices. For more details, please refer to Prompting behavior if declined.

📘

Does not replace native browser prompt

This does not replace the Native Browser Prompt required for subscription. You must obtain permissions using the native browser prompt.

Prompt behavior

When declined, future calls will be ignored for at least three days. Further declines will lengthen the time required to elapse before prompting the user again – refer to our guide for more info on dismissing web promps.

To override this back-off behavior to prompt the user again, you can pass {force: true}. However, to provide a good user experience, bind the action to a UI-initiated event like a button click.

promptPush()

Displays the notification permission prompt.

OneSignal.Slidedown.promptPush();

promptPushCategories()

Displays the notification permission prompt for notification categories.

OneSignal.Slidedown.promptPushCategories();

promptSms()

Displays the SMS subscription prompt.

OneSignal.Slidedown.promptSms();

promptEmail()

Displays the email subscription prompt.

OneSignal.Slidedown.promptEmail();

promptSmsAndEmail()

Displays the SMS and email subscription prompts simultaneously.

OneSignal.Slidedown.promptSmsAndEmail();

addEventListener() Slidedown

Add a callback to detect the Slidedown prompt shown event.

OneSignalDeferred.push(function() {
  OneSignal.Slidedown.addEventListener('slidedownShown', function (event) {
    console.log('slidedownShown', { event });
  });
});

Push Subscription

id

The user's push subscription ID. See Subscriptions for more details.

OneSignal.User.PushSubscription.id;

token

The subscription's push token. Required to receive push notifications.

OneSignal.User.PushSubscription.token;

optOut()

Changes the subscription status of an opted-in push subscription to opted-out. The push subscription cannot get push notifications anymore until optIn() is called or use Update subscription API with enabled: true.

This method does not remove or invalidate push tokens. It is designed for sites that wish to have more granular control of which users receive notifications, such as when implementing notification preference pages.

The user's push subscription can only be opted-out if OneSignal.Notifications.permission is true.

OneSignal.User.PushSubscription.optOut();

optIn()

If you previously called the optOut() method, this changes the subscription status to opted-in. If the push token on the subscription is valid, the user should be able to get push notifications again.

This method does not trigger the website prompts and does not set or validate push tokens. It is designed for sites that wish to have more granular control of which users receive notifications, such as when implementing notification preference pages.

The user's push subscription can only be changed back to opted-in if both conditions are met:

1. OneSignal.Notifications.permission is true.
2. the optOut() method was previously used.

OneSignal.User.PushSubscription.optIn();

optedIn

Returns true or false based on the current push subscription status.

OneSignal.User.PushSubscription.optedIn;

addEventListener() Push subscription

The change listener is fired when any of the fields on the subscription change. The event includes both the current and the previous state.

PushSubscriptionNamespaceProperties

function pushSubscriptionChangeListener(event) {
  if (event.current.token) {
    console.log(`The push subscription has received a token!`);
    //this is a good place to call OneSignal.login and pass in your user ID
  }
}

OneSignal.User.PushSubscription.addEventListener("change", pushSubscriptionChangeListener);

Email

addEmail()

Adds an email subscription (email address) to the current user.

OneSignal.User.addEmail("[email protected]");

📘

Use Identity Verification

If you have a backend server, we strongly recommend using Identity Verification with your users. Your backend can generate an Email Authentication Token and send it to your app.

removeEmail()

Deletes the email subscription from the OneSignal App.

OneSignal.User.removeEmail("[email protected]");

SMS

addSms()

Adds an SMS subscription (phone number) to the current user. Requires phone numbers to follow the E.164 international telephone number plan.

OneSignal.User.addSms("+15558675309");

📘

Use Identity Verification

If you have a backend server, we strongly recommend using Identity Verification with your users. Your backend can generate an SMS Authentication Token and send it to your app or website.

removeSms()

Deletes the SMS subscription from the OneSignal App.

OneSignal.User.removeSms("+15558675309");

Debugging

Enable logging to help debug if you run into an issue setting up OneSignal. This selector is static, so you can call it before initializing OneSignal. For more info, see Debugging with Browser DevTools.

setLogLevel()

Set the logging level to print to the DevTools console.

OneSignal.Debug.setLogLevel(“trace”);

Log levels

• 'trace'
• 'debug'
• 'info'
• 'warn'
• 'error'