Skip to main content

Mailgun Adaptor

About Mailgun​

Mailgun is an email delivery service designed for developers and provides APIs for sending, receiving, and tracking emails.

Integration Options​

Mailgun supports 2 primary integration options with OpenFn:

  1. Rest API: Mailgun has a REST API that enables external services like OpenFn to pull data from Mailgun, or push data from external apps to Mailgun. This option is suited for scheduled, bulk syncs or workflows that must update data in Mailgun with external information. See functions for more on how to use this adaptor to work with the API.

  2. Webhook: Webhook or Data Forwarding to push data from Mailgun to external systems (see docs). This option is suited for real-time, event-based data integration.

Authentication​

  1. See Mailgun docs for the latest on supported authentication methods.
  2. When integrating with Mailgun via OpenFn, there is one primary authentication method that is supported: API Key. See this adaptor's Configuration docs for more on the required authentication parameters.

See platform docs on managing credentials for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:

{
  "domain": "sandbox-123.mailgun.org",
  "apiKey": "otherThiNGfSECret"
}
  1. Mailgun API Documentation
  2. Event Webhooks
  3. Support and Community

I've noticed a problem with this Adaptor, or something is out of date, what can I do?​

Thanks for asking! We are a fully Open Source Digital Public Good, and we welcome contributions from our community. Check out our Adaptors Wiki for more information on how you can update Adaptors!

Or, you can always reach out to the Community through our Community Forum here.