2024.10.4
Home ▸ Integrations ▸

SendGrid

The sendgrid notification integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] 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 configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file. After changing the configuration.yamlThe configuration.yaml file is the main configuration file for Home Assistant. It lists the integrations to be loaded and their specific configurations. In some cases, the configuration needs to be edited manually directly in the configuration.yaml file. Most integrations can be configured in the UI. [Learn more] file, restart Home Assistant to apply the changes. The integration is now shown on the integrations page under Settings > Devices & services. Its entities are listed on the integration card itself and on the Entities tab.

# Example configuration.yaml entry
notify:
  - name: NOTIFIER_NAME
    platform: sendgrid
    api_key: YOUR_API_KEY
    sender: SENDER_EMAIL_ADDRESS
    recipient: YOUR_RECIPIENT

Configuration Variables

Looking for your configuration file?
name string (Optional, default: notify)

Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the notify.NOTIFIER_NAME action.

api_key string Required

Your SendGrid API key.

sender string Required

The email address of the sender.

sender_name string (Optional)

The name of the sender. Defaults to “Home Assistant” if not set.

recipient string Required

The recipient of the notification.

To use notifications, please see the getting started with automation page.

Related topics