Skip to content

Alerts (0.0.1)

Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference.

Download OpenAPI description
openapi-final.json
openapi-final.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

https://api.eu.mailgun.net/

Domains

Operations

Inbox Placement

Inbox Placement testing allows you to see the likely deliverability of your email campaigns.

Operations

Email Preview

This API provides functionality to create and manage email preview tests, as well as create shareable links.

Operations

List Clients

Request

Returns a list of clients that can perform an email preview.

Security
basicAuth
curl -i -X GET \
  -u <username>:<password> \
  https://api.mailgun.net/v1/preview/tests/clients

Responses

A 200 response

Bodyapplication/json
clientsobjectrequired
clients.​property name*object(Email_Preview_API_github.com-mailgun-emailpreview-clients-preview-ClientInfo)additional property
Response
application/json
{
  "clients": {
    "android10_gmailapp_pixel4_dm": { … }
  }
}

Get Test Results

Request

Returns the results for the specified email preview test.

Security
basicAuth
Path
test_idstringrequired

Test to get results for

curl -i -X GET \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/tests/{test_id}/results'

Responses

A 200 response

Bodyapplication/json
property name*object(Email_Preview_API_github.com-mailgun-emailpreview-clients-preview-TestResult)additional property
Response
application/json
{
  "android10_gmailapp_pixel4_dm": {
    "id": "android10_gmailapp_pixel4_dm",
    "displayname": "Gmail App Pixel 4",
    "client": "Gmail App",
    "os": "Android 10 (Dark Mode)",
    "category": "Mobile",
    "browser": "",
    "screenshots": { … },
    "thumbnail": "https://images.emailonacid.com/1234",
    "fullthumbnail": "https://images.emailonacid.com/90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "status": "Complete",
    "statusdetails": { … }
  },
  "android10_gmailapp_pixel4_lm": {
    "id": "android10_gmailapp_pixel4_lm",
    "displayname": "Gmail App Pixel 4",
    "client": "Gmail App",
    "os": "Android 10",
    "category": "Mobile",
    "browser": "",
    "screenshots": { … },
    "thumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3Z0479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "fullthumbnail": "https://images.emailonacid.com/YXBpLzRRZVp3ZzlBbmJydjVEZjBUOW9obUxpU1RUQmpe=d90479d4733fc5f409475644cb01384b0b21bc53f1c32e0ed609756dfb63d2f5%3A1741804257",
    "status": "Complete",
    "statusdetails": { … }
  }
}

Reprocess Emailpreview Test

Request

Reprocesses the test for the passed clients.

Security
basicAuth
Path
test_idstringrequired

Test to reprocess

curl -i -X PUT \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/preview/tests/{test_id}/results/reprocess'

Responses

A 200 response

Bodyapplication/json
property name*object(Email_Preview_API_github.com-mailgun-emailpreview-clients-preview-ReprocessInfo)additional property
Response
application/json

Spam Traps Monitoring

Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps.

Operations

Email Health Score

Operations

IP Blocklist Monitoring

Operations

Domain Blocklist Monitoring

Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked.

Operations

Google Postmaster Tools

This API provides access to Google Postmaster data.

Operations

Microsoft SNDS

This API provides access to Microsoft SNDS data.

Operations

Alerts

Operations