Email Quickstart
How to set up email messaging with OneSignal.
Email remains a powerful channel for reaching your users outside of your app or website. Every industry can leverage email's power to increase engagement, conversions, and retention. 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 (ESP) listed below. If you do not have an account with a third party ESP already, get started quickly with OneSignal Email and ask about Email Onboarding.
| Email Providers | Details |
|---|---|
| OneSignal Email Setup | Supported |
| SendGrid Setup | Supported |
| Mailgun Setup | Supported |
| Mailchimp Setup | Supported |
| Amazon SES | Not Supported |
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. External User ID
Required if using integrations.
Recommended for identifying the user that owns the email address.
OneSignal creates a unique email subscription ID called the player_id. A single user can have multiple player_id records based on how many devices, email addresses, and phone numbers they use to interact with your app.
Use the OneSignal External User ID to identify the user and map the associated player_id records.
Step 5. 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 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
You can send messages to test functionality and for ad hoc campaigns through the Dashboard or API Email Creation.
Set up automatic email and omni-channel sequences using Journeys.
As you start sending emails, its highly encouraged to follow a Warm-Up Plan to build your domain reputation, increase deliverability and make sure you don’t get listed as spam.
Done!
You are a OneSignal Email Pro! If you have any questions, feel free to drop us a line!
Email us at [email protected]
Chat directly with support.
Updated over 1 year ago