To be able to receive webhooks from Mailgun, your Home Assistant instance needs to be accessible from the web (Hass.io instructions) and you need to have the
base_url configured for the HTTP component (docs).
To set it up, go to the integrations page in the configuration screen and find Mailgun. Click on configure. Follow the instructions on the screen to configure Mailgun.
You will get a URL of the following format:
https://<home-assistant-domain>/api/webhook/9940e99a26fae4dcf6fe0a478124b6b58b578ea4c55c9a584beb1c9f5057bb91. To receive webhooks from Mailgun, you need to provide that url as a callback URL in the Webhooks tab of the Mailgun Control Panel.
There is currently support for the following device types within Home Assistant:
# Example configuration.yaml entry mailgun: domain: EXAMPLE.COM api_key: YOUR_API_KEY
(string)(Required)This is the domain name to be used when sending out mail. Needs to be the first custom domain you have set up.
(string)(Required)This is the API token that has been generated in your Mailgun account.
(boolean)(Optional)(Deprecated) Whether to use the sandboxed domain for outgoing mail. Since the
domainitem is required, it should be set to the sandbox domain name, so this isn’t needed.
Default value: false
Events coming in from Mailgun will be available as events in Home Assistant and are fired as
mailgun_message_received. The data specified by Mailgun will be available as the event data. You can use this event to trigger automations.
You can then consume that information with the following automation:
automation: trigger: platform: event event_type: mailgun_message_received event_data: action: call_service action: service: light.turn_on entity_id: light.office
The Mailgun notification service allows you to send emails via Mailgun’s REST API. It requires the Mailgun component to be set up.
# Example configuration.yaml entry notify: - name: mailgun platform: mailgun recipient: [email protected]
(string)(Required)This is the domain name to be used when sending out mail.
(boolean)(Optional)(Deprecated) If a sandboxed domain is used, specify it in
Default value: false
(string)(Required)This is the API Key that has been generated in your Mailgun account.
(string)(Required)The email address of the recipient.
(string)(Optional)The sender’s email address.
[email protected], where
DOMAINis the outgoing mail domain, as defined by the
The following automation reacts to an event by sending out an email with two attachments.
# Example automation using Mailgun notifications automation: trigger: platform: event event_type: SPECIAL_EVENT action: service: notify.mailgun data: title: "Something special has happened" message: "This a test message from Home Assistant" data: images: - /home/pi/pic_test1.png - /home/pi/pic_test2.png