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

Email & Phone Number Web Prompt

The new phone number and email web prompts can be configured via the dashboard for Typical Site setups and via initialization options for Custom Code setups. You can prompt for phone numbers, email, or both. You choose the wording, labels, and even the confirmation message. OneSignal will collect and synchronize these data on our systems.

Typical Site Configuration

You can configure the prompt(s) in the Web Configuration page for your site Settings. Look for the "Add Prompt" button in the Permission Prompt Setup section. Click on "Email/Phone Prompt."

Next, configure which channels you would like to capture and customize the action text, labels, and auto prompt delays.

Leaving the configuration fields blank will result in the default values being used.

Custom Code Setup

You can activate the Email & Phone Slidedown via custom code by passing in one of the following prompt option types for the type parameter:

  • "sms"
  • "email"
  • "smsAndEmail"
OneSignal.init({
  // Your other init options here
  promptOptions: {
      slidedown: {
        prompts: [
          {
            type: "email",
            autoPrompt: false,
            text: {
              actionMessage: "We'd like to send you emails for the latest Aggie news and updates.",
              acceptButton: "Sign up",
              cancelButton: "Cancel",
            },
            delay: {
              pageViews: 1,
              timeDelay: 20
            },
          }
        ]
      }
  }
  // Continue other init options here
}

Note: if no other parameters are passed into the slidedown options object, the default values will be used.

Triggering the Slidedowns

Function

Description

showEmailSlidedown

Prompt for email.

showSmsSlidedown

Prompt for SMS.

showSmsAndEmailSlidedown

Prompt for both email and SMS.

Validation

We want apps to be able to easily collect accurate contact information. That's why OneSignal provides automatic validation for the two input field types. The slidedown will only accept valid emails and phone numbers (even as it pertains to country code and format).

Synchronization

After a visitor submits their information, OneSignal will automatically collect the information and synchronize the data across channels. For example, if the application has an existing push subscription for a specific user and the user submits a phone number, OneSignal will synchronize the two records. If an email address is also submitted, the three channels will be linked. However, a push record is not needed to capture emails and phone numbers.

Sending tags in the WebSDK (via Category Slidedown or otherwise) will synchronize all "subscribed" and connected channels (email, SMS, push) with the tags. Adding an external identifier will do the same -- that is, adding an external identifier to one channel will add the identifier to any other existing channels.

Back off logic

Email/ Phone Number Slide Prompts are governed by a single back off logic. If you have multiple such prompts then after the first email/phone prompt is accepted/declined, subsequent prompts will appear after 3 days, 7 days for the second re-prompt, or 30 days for the third attempt. So, we recommend you to collect email and phone numbers in the same prompt if you want to capture both these user details.
This behavior ensures a great experience for your website visitors and avoids overwhelming them with multiple prompts.

Examples:
I have 2 email only prompts, first for 1 page view 3 seconds, second for 3 page views 3 seconds. User submits their email address on first prompt. Does the second email prompt ever appear? Assuming no but want to confirm.
no it wouldn't appear since the user is already "subscribed" to email

I have a phone/email prompt for 1 page view 3 seconds, and then a phone prompt 2 page views 3 seconds. User enters their email in first prompt but not phone number. Does the phone prompt appear and when?
the phone prompt will appear after 3 days
I have 8 different email prompts, all 1 page view 3 seconds. User dismisses them each time they appear. How often do they appear?
only the first configured prompt will appear following the backoff logic i.e. 3 days, 7 days, 30 days

FAQ

Is this feature free?

This feature is available across all tiers, including free accounts.

Updated 19 days ago


Email & Phone Number Web Prompt


Suggested Edits are limited on API Reference Pages

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