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

Mandrill Setup

How to setup Mandrill for use in OneSignal Email Messaging

OneSignal's Email Messaging requires the use of a third-party email service provider to handle email delivery. All you have to do is set up the integration between the provider and OneSignal, and you'll be ready to send emails through OneSignal.

Step 1. Create Mailchimp account, and add Mandrill

Mandrill is the transactional email service offered by Mailchimp. To set up Mandrill, you must first create a Mailchimp account if you do not already have one. Then, enable the Mailchimp Transactional Email Plan (first 500 sends are free).

Step 2. Configure your domain for email

Navigate to the Mandrill App <a href="https://mandrillapp.com/settings/sending-domains" target="_blank>Settings > Domains > Sending Domains and add your domain if you have not done so already.

When your domain is added, click View DKIM/SPF Setup Instructions, which provides the appropriate DNS settings you will need to update your domain. You can also verify your domain by clicking View details and receiving an email to your domain.

Next, you will need to update your DNS records for your domain host. Follow Mailchimp/Mandrill's instructions to learn more.

Once you have set up your DNS records, it make take up to 48 hours to work. Mailchimp will email you when your domain is verified.

Step 3. Create API Key

In Mandrill, click Settings and + New API Key.

Optional: Name your API key something like OneSignal API Key.

You will see your key was created successfully. Next, highlight the API key and copy it to your clipboard. Also note your SMTP Username here.

🚧

CAUTION! API Keys need to be secret

Your Mailchimp API Key is like a password. Keep it safe and do not share it.

Step 4. Enable Email Messaging

In OneSignal, go to Settings > Platforms > Email

Select Mailchimp as the provider, and paste in the API key and SMTP Username.

Delivery Defaults

Add a default name and email address that you want your emails to come from. These may be changed later on a per-message basis.

Import Emails

Select Upload CSV to Import Email Addresses. You can always do this again later.

If you have a website and want to prompt users to provide you email. Select Add Web Prompt to use OneSignal's Email Web Prompt.

πŸ‘

Done!

You can now start sending emails. Go to Sending Email Messages.

Step 5. Identity Verification

Optional

To validate emails through your own backend server, you can enable Identity Verification in OneSignal dashboard Settings > Keys & IDs toggle on "Identity Verification for email + external_id (recommended)".

Read more on how to setup your backend for Identity Verification.


FAQ

Which API Key Permissions do I need to enable?

Since our API does a lot of communication between both platforms, you will likely need these permissions at the least:

Why are email analytics not tracked?

Within Mandrill > Settings > Webhooks make sure you have a hooked into OneSignal's endpoint https://onesignal.com/email/hooks/mandrill with the following settings:

Updated a day ago



Mandrill Setup


How to setup Mandrill for use in OneSignal Email Messaging

Suggested Edits are limited on API Reference Pages

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