Skip to content
Mailgun Optimize
/
Mailgun Optimize API Reference
/
Alerts
/
Test webhook

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

Reset Webhook Signing Key

Request

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

Responses

A 200 response

Bodyapplication/json
signing_keystringrequired
Response
application/json
{
  "signing_key": "string"
}

Test webhook

Request

Sends test webhook request to specified url with dummy data.

Security
basicAuth
Bodyapplication/jsonrequired
event_typestringrequired
urlstringrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/alerts/webhooks/test \
  -H 'Content-Type: application/json' \
  -d '{
    "event_type": "some-event",
    "url": "https://some-webhook-url.com/webhook"
  }'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "string"
}

Test message

Request

Sends test message to emails with dummy data.

Security
basicAuth
Bodyapplication/jsonrequired
event_typestringrequired
emailsArray of stringsrequired
curl -i -X POST \
  -u <username>:<password> \
  https://api.mailgun.net/v1/alerts/email/test \
  -H 'Content-Type: application/json' \
  -d '{
    "event_type": "some-event",
    "emails": [
      "email1@example.com",
      "email2@example.com"
    ]
  }'

Responses

A 200 response

Bodyapplication/json
messagestringrequired

Response message

Response
application/json
{
  "message": "string"
}