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 Quickstart

How to set up email messaging with OneSignal.

This guide will walk you through all the steps to have full email integration with OneSignal.

Step 1. Setup Email Service Provider Support

Required unless setup for you by OneSignal.

Sending emails through OneSignal requires an account with an eligible email service provider listed below. If you do not have an account with any of these Email Providers Contact OneSignal's Sales Team and ask about Email Onboarding.

Step 2. Add SDK Code

Optional but recommended if using the OneSignal SDK. Methods provided for creating new email records as they are provided to you. See Email SDK Methods to for a full list and example code.

Step 3. Email Web Prompt

Optional but recommended if you have a website and want to prompt users to provide their email. Use the Email & Phone Number Web Prompt to start gathering emails through a web prompt.

Step 4. Import Emails

Optional but recommended if you already have a list of email addresses and wish to immediately start sending emails, you can import them into OneSignal.

You can import emails through our Dashboard or server API. Details and code examples are available in Import Email Addresses guide.

Step 5. External User Ids

Required if using integrations.
Each email record in OneSignal gets a unique player_id (OneSignal's Device Id). The email player_id will be different from the push record player_id.

To map the unique email and push player_ids together under a single User Id, use the OneSignal setExternalUserId SDK method. See External User Ids. It is recommended to call this method after the email is set.

Step 6. Send Tags

Use Data Tags for custom user and event properties. These allow for message personalization and segmentation.

Common tags used for message personalization:

Tag KeyTag Value
real_nameuser’s full real name
first_nameuser’s first name
last_nameuser’s last name
user_namename that users give themselves; often not a real name (e.g. PokeCatcher22)
salutationif you wish to refer to users by a salutation (Ms, Dr, Hon, etc)

Step 7. Send Emails

Send emails using OneSignal's:



You are a OneSignal Email Pro!

Updated 10 days ago

Email Quickstart

How to set up email messaging with OneSignal.

Suggested Edits are limited on API Reference Pages

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