Getting Started
To use the Mailgun provider in the email channel, you will need to create a Mailgun account and add your API key and domain name to the Mailgun integration on the Novu platform.Generating an API Key
To generate a new API key in Mailgun, you can follow these steps:- Sign up or Log in to your Mailgun account.
- Click on the Profile section in the top right corner of the screen, and then click “API Keys” from the drop-down menu.
- On the API Keys page, copy the generated Private API Key
Adding a new domain name
Mailgun recommends that you add a subdomain as a domain name. To do so:- Visit the page to add a domain name.
- During this process, you will need to choose a region for the domain name which is between
US
andEU
. The default isUS
.
- During this process, you will need to choose a region for the domain name which is between
- Follow the instructions to verify the domain name.
Creating a Mailgun integration with Novu
- Visit the Integrations page on Novu.
- Click on Add a Provider.
- Select Mailgun service.
- Enter your Mailgun API Key.
- Enter your Base URL.
- For domains created in the EU region, the base URL is:
https://api.eu.mailgun.net/
- Otherwise, leave the base URL blank.
- For domains created in the EU region, the base URL is:
- Fill in the
Username
. - Fill in the
Domain name
registered on Mailgun. - Fill in the
From email address
field using the authenticated email from the previous step. - Fill in the
Sender's name
. - Click on the
Disabled
button and mark it asActive
. - Click on the Update button.
- You should now be able to send notifications using Mailgun in Novu.