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

Mailgun Setup

How to setup Mailgun for use in OneSignal Email Messaging

Beta Feature

OneSignal 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 Mailgun account

If you do not already have a Mailgun account, create one now.

Step 2. Configure your domain for email

Next, you will need to set up your domain so that it can send emails from Mailgun. Go to Domains and click 'Add New Domain'

Then, add your domain:

Next, you will be given an two TXT (SPF and DKIM), two MX, and a CNAME record you must change:

Next, you will need to update your DNS records for your domain host.

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


How do I change my domain's email settings?

Step 3. Get your Credentials

Next, in Mailgun go to Domains and click the domain you are setting up with email:

From the domain's page, copy the Default SMTP Login, Default Password, and API Key:

Your Mailgun API key and SMTP credentials are like a password. Keep them safe and do not share them.

Step 4. Enable Email Messaging

Go to Settings > Platforms and scroll down until you see Email and click on it.

Next, you must configure your email settings. Select Mailgun as the provider, and paste in the Domain you set up with Mailgun, API key, SMTP Username (aka SMTP Login), and SMTP Password (aka Default Password) you just copied in Step 2.

Delivery Defaults

Add the name and email address that you want your emails to come from (you may override these when sending a message from New Email)

Identity Verification


By default, Identity Verification is disabled, however we recommend using it. You can enable Identity Verification here if you can support it.

You're done! You can now start sending emails. Go to Sending Email Messages.


How do I set up OneSignal if I already have an active Webhook in Mailgun?

To simplify setup and be able to access email delivery statistics, OneSignal will automatically configure Webhooks with Mailgun. Unfortunately, Mailgun only supports a single webhook for a given account. OneSignal requires webhooks to use Email Messaging, which may conflict with webhooks previously set up (e.g. for an analytics integration).

If you need the webhook you previously set up, you should contact us for possible workarounds.

If you do not need the webhook you previously set up, you must disable it.

Mailgun Setup

How to setup Mailgun for use in OneSignal Email Messaging

Beta Feature

Suggested Edits are limited on API Reference Pages

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