mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-30 06:46:49 +00:00
2602651bdc
* Rename Services to Actions in integrations: S * Update source/_integrations/scene.markdown * Update source/_integrations/scene.markdown * tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
63 lines
1.7 KiB
Markdown
63 lines
1.7 KiB
Markdown
---
|
|
title: SendGrid
|
|
description: Instructions on how to add email notifications via SendGrid to Home Assistant.
|
|
ha_category:
|
|
- Notifications
|
|
ha_release: 0.14
|
|
ha_domain: sendgrid
|
|
ha_iot_class: Cloud Push
|
|
ha_platforms:
|
|
- notify
|
|
ha_integration_type: integration
|
|
related:
|
|
- docs: /docs/configuration/
|
|
title: Configuration file
|
|
---
|
|
|
|
The `sendgrid` notification {% term integration %} sends email notifications via [SendGrid](https://sendgrid.com/), a proven cloud-based email platform.
|
|
|
|
## Setup
|
|
|
|
You need an [API key](https://app.sendgrid.com/settings/api_keys) from SendGrid.
|
|
|
|
## Configuration
|
|
|
|
To enable notification emails via SendGrid in your installation, add the following to your {% term "`configuration.yaml`" %} file.
|
|
{% include integrations/restart_ha_after_config_inclusion.md %}
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
notify:
|
|
- name: NOTIFIER_NAME
|
|
platform: sendgrid
|
|
api_key: YOUR_API_KEY
|
|
sender: SENDER_EMAIL_ADDRESS
|
|
recipient: YOUR_RECIPIENT
|
|
```
|
|
|
|
{% configuration %}
|
|
name:
|
|
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the `notify.NOTIFIER_NAME` action.
|
|
required: false
|
|
default: notify
|
|
type: string
|
|
api_key:
|
|
description: Your SendGrid API key.
|
|
required: true
|
|
type: string
|
|
sender:
|
|
description: The email address of the sender.
|
|
required: true
|
|
type: string
|
|
sender_name:
|
|
description: The name of the sender. Defaults to "Home Assistant" if not set.
|
|
required: false
|
|
type: string
|
|
recipient:
|
|
description: The recipient of the notification.
|
|
required: true
|
|
type: string
|
|
{% endconfiguration %}
|
|
|
|
To use notifications, please see the [getting started with automation page](/getting-started/automation/).
|