mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-31 15:26:49 +00:00
72631830da
* Standardized values in the example configuration Removed what appear to be an actual API key from the example configuration.yaml block. And, replaced with values as described in the [developer docs](https://developers.home-assistant.io/docs/en/documentation_standards.html#component-and-platform-pages) * Standardize example configuration-ecobee * Standardize example configuration-coinbase * Standardize example configuration-google assistant * Standardize example configuration-cloudflare * Standardize example configuration-cloudflare * Standardize example configuration-habitica * Standardize example configuration-ifttt * Standardize example configuration-openalpr * Standardize example configuration-multiple * Standardize example configuration-instapush * Standardize example configuration-llamalab * Standardize example configuration-notify * Standardize example configuration-mailgun * Standardize example configuration-MULTIPLE * Standardize example configuration-rtm * Standardize example configuration-spotcrime * Standardize example configuration-trafikverket * Standardize example configuration-uk transport * Standardize example configuration-wunderground * Standardize example configuration-wsdot * Standardize example configuration-telegram * Standardize example configuration-tts * Standardize example configuration-tts, vultr * Replace email entry * Replace IP address * Place email address
36 lines
1.2 KiB
Markdown
36 lines
1.2 KiB
Markdown
---
|
|
layout: page
|
|
title: "SendGrid"
|
|
description: "Instructions on how to add email notifications via SendGrid to Home Assistant."
|
|
date: 2016-02-27 18:00
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: sendgrid.png
|
|
ha_category: Notifications
|
|
---
|
|
|
|
The `sendgrid` notification platform sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.
|
|
|
|
To enable notification emails via SendGrid in your installation, add the following to your `configuration.yaml` file:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: sendgrid
|
|
api_key: YOUR_API_KEY
|
|
sender: SENDER_EMAIL_ADDRESS
|
|
recipient: YOUR_RECIPIENT
|
|
```
|
|
|
|
Configuration variables:
|
|
|
|
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
|
|
- **api_key** (*Required*): SendGrid API key - https://app.sendgrid.com/settings/api_keys
|
|
- **sender** (*Required*): E-mail address of the sender.
|
|
- **recipient** (*Required*): Recipient of the notification.
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|