Update domain webhooks (v4)

Request

Update webhook URL to associate it with different event types. This replaces the existing event type associations for the given URL.

Security

basicAuth

Path

domainstringrequired

The domain name to update webhooks for

Bodyapplication/x-www-form-urlencodedrequired

urlstringrequired

The webhook URL to update

event_typesstringrequired

Event types to associate with this URL. Use multiple times to specify multiple event types. This replaces the existing associations.

Enum Value	Description
accepted	The accepted event occurs when Mailgun accepts a message for delivery.
clicked	The clicked event occurs when a recipient clicks a link in the email. This requires click tracking to be enabled for the domain.
opened	The opened event occurs when a recipient opens the email. This requires open tracking to be enabled for the domain.
unsubscribed	The unsubscribed event occurs when a recipient unsubscribes using an unsubscribe mechanism in your email (for example, a list-unsubscribe link).
delivered	The delivered event occurs when an email is successfully delivered to the recipient's mail server.
permanent_fail	The permanent_fail event occurs when an email cannot be delivered due to a permanent error.
temporary_fail	The temporary_fail event occurs when an email cannot be delivered due to a temporary error.
complained	The complained event occurs when a recipient marks your email as spam or their email provider registers a spam complaint.

curl -i -X PUT \
  -u '<username>:<password>' \
  'https://api.mailgun.net/v4/domains/{domain}/webhooks' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d url=string \
  -d event_types=accepted

Responses

A 200 response

Bodyapplication/json

webhooksobject(github.com-mailgun-domains-httpapi-WebhooksResponse)required

List of webhooks

Response

{
  "webhooks": {
    "delivered": { … },
    "opened": { … },
    "clicked": { … }
  }
}