Reference

Mailgun

Mailgun is a cloud-based email service provider that allows for sending transactional emails.

Mailgun is a cloud-based email service provider that allows for sending transactional emails.

Category: Communication. Adds 2 actions to a care flow.

What to configure

Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.

SettingRequiredNotes
API KeyYesYour Mailgun API Key so the extension can authenticate with the Mailgun API. Stored as a secret.
DomainYesThe domain used to send the emails from.
From emailYesThe email address that will be used for the "From" header.
From nameYesThe name that will be used for the "From" header.
RegionNoSending domains can be provisioned in different regions. Pass "EU" for Europe or "US" for United States. Defaults to "US".
Test modeNoSet to "Yes" if you want to execute all API calls to Mailgun in test mode.

Actions

Mailgun adds these 2 actions to a care flow. Add one to a step, then fill in its inputs.

Send email

Send an email to a recipient of your choice.

InputTypeRequiredDescription
TostringYesThe email address of the recipient.
SubjectstringYesThe subject of your email.
BodyhtmlYesThe content of your message.

Allows for sending a plain email to a recipient.

Send email with template

Send an email based on a template.

This action can be previewed in Studio before you publish.

InputTypeRequiredDescription
TostringYesThe email address of the recipient.
TemplatestringYesThe name of the template you created in the Mailgun web portal.
SubjectstringYesThe subject of your email.
VariablesjsonNoPass values for variables you defined in your template.

Setup and notes

Mailgun is a cloud-based email delivery service that allows businesses and developers to send, receive, and track email messages. It provides a powerful set of APIs that enable users to integrate email into their applications, automate email delivery, and improve deliverability rates.

With Mailgun, users can send transactional emails as well as marketing emails, newsletters, and other types of bulk email. The platform also offers real-time email analytics and tools to manage unsubscribes and bounces. Overall, Mailgun provides a reliable and scalable solution for businesses and developers to handle their email needs.

Extension settings

In order to set up this extension, you will need to provide a:

  1. Mailgun API key
  2. Mailgun domain
  3. From name
  4. From email

Send email with a template

Allows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.

Changelog

Mailgun changelog

Where this page comes from

The settings, actions, inputs, outputs and webhooks above are generated from the extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the platform actually does rather than a description of it.

Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.

On this page