Skip to content
Mailgun Optimize
/
Mailgun Optimize API Reference
/
Alerts
/
Remove Alert

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
inboxready.json
inboxready.yaml
Languages
Servers
US Mailgun

https://api.mailgun.net/

EU Mailgun

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

Domains

Operations

DMARC Reports

DMARC reporting provides valuable insights into your infrastructure, helping you identify potential issues like senders, misconfigured email servers, or phishing attempts.

Operations

Inbox Placement

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

Operations

Bounce Classification

Operations

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

Update Alert

Request

Use this endpoint to update an existing alert setting record.

NOTE: When updating a webhook alert, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned, a 400 will be returned and the alert setting update will be rejected.

Security
basicAuth
Path
idstringrequired

The settings ID.

Bodyapplication/jsonrequired
event_typestringrequired

The type of event for which you would like to receive alerts.

channelobjectrequired

The delivery method for the alert.

settingsobjectrequired

The details pertaining to the specified channel. Please note that the contents of this object differ per channel type.

settings.​urlstring

For webhook channel.

settings.​emailsArray of strings

For email channel

settings.​channel_idsArray of strings

For slack channel

curl -i -X PUT \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/alerts/settings/events/{id}' \
  -H 'Content-Type: application/json' \
  -d '{
    "event_type": "ip_delisted",
    "channel": "email",
    "settings": {
      "emails": [
        "recipient-a@example.com",
        "recipient-b@example.com"
      ]
    }
  }'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "settings updated"
}

Remove Alert

Request

Security
basicAuth
Path
idstringrequired

The settings ID.

curl -i -X DELETE \
  -u <username>:<password> \
  'https://api.mailgun.net/v1/alerts/settings/events/{id}'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "settings deleted"
}

List Alerts

Request

This endpoint returns a list of all configured alert settings for your account.

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

Responses

A 200 response

Bodyapplication/json
eventsArray of objects(github.com-mailgun-alerts-internal-settings-EventSettings)required
events[].​idstring(uuid)

The unique identifier for the alert settings record.

events[].​event_typestringrequired

The event type that is alerted on. Check GET /v1/alerts/events for possible values.

events[].​channelobjectrequired

The delivery channel for the alert.

events[].​settingsobjectrequired

This object contains channel-specific settings.

events[].​settings.​urlstring

For webhook channel.

events[].​settings.​emailsArray of strings

For email channel

events[].​settings.​channel_idsArray of strings

For slack channel

events[].​disabled_atstring or null(date-time)

Read only. When present

webhooksobject(github.com-mailgun-alerts-internal-settings-Webhooks)required
webhooks.​signing_keystringrequired
slackobject(github.com-mailgun-alerts-internal-settings-Slack)required
slack.​tokenstringrequired
slack.​team_idstring or nullrequired
slack.​team_namestring or nullrequired
slack.​scopestring or nullrequired
Response
application/json
{
  "events": [
    { … },
    { … },
    { … }
  ],
  "webhooks": {},
  "slack": {}
}