Skip to main content

Mailgun source

Use the Mailgun source connector to connect to the Mailgun API.

Setup​

Prerequisites​

  • A Mailgun account
  • A Private API key (Mailgun API key)
  • Your Mailgun region (US or EU)

Get your Mailgun Private API key​

  1. Log in to Mailgun.
  2. Navigate to your API keys (typically under Settings or API Security).
  3. Copy the Private API key.

Authentication​

This connector authenticates to Mailgun using HTTP Basic Auth:

  • Username: api
  • Password: your Private API key

During connection testing, the connector validates credentials by calling:

  • GET /v3/domains

against the region-specific API base URL.

Configuration​

FieldTypeRequiredDescription
regionstring✅Mailgun region. Must be US or EU (case-insensitive; surrounding whitespace is ignored). Determines the API base URL.
private_api_keystring✅Your Mailgun Private API key used for Basic Auth.

Region to API base URL mapping​

  • US → https://api.mailgun.net
  • EU → https://api.eu.mailgun.net

Streams​

This connector is currently under development and does not yet expose any streams.

Limitations​

  • Extraction is not yet implemented. Connection testing (credential validation) is supported, but syncs will fail until extraction is released.