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 on your app or website

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

Step 1. Setup Email Service Provider Support

Required
OneSignal Email Messaging requires an account with an eligible email service provider.

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.

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.
Recommended
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 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

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

Common tags used for message personalization:

Tag Key

Tag Value

real_name

user’s full real name

first_name

user’s first name

last_name

user’s last name

user_name

name that users give themselves; often not a real name (e.g. PokeCatcher22)

salutation

if you wish to refer to users by a salutation (Ms, Dr, Hon, etc)

Step 7. Send Emails

Send emails using OneSignal's:

👍

Done!

You are a OneSignal Email Pro!

Updated 4 days ago



Email Quickstart


How to set up email messaging on your app or website

Suggested Edits are limited on API Reference Pages

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