home-assistant.io/source/_integrations/sendgrid.markdown

title	description	ha_category	ha_release	ha_domain	ha_iot_class	ha_platforms	ha_integration_type	related	ha_quality_scale
SendGrid	Instructions on how to add email notifications via SendGrid to Home Assistant.	Notifications	0.14	sendgrid	Cloud Push	notify	integration	docs title /docs/configuration/ Configuration file	legacy

The sendgrid notification {% term integration %} sends email notifications via SendGrid, a proven cloud-based email platform.

Setup

You need an API key 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 %}

# 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.