SendGrid


The sendgrid notification platform 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.yaml file:

# 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

(string)(Optional)Setting the optional parameter name allows multiple notifiers to be created. The notifier will bind to the service notify.NOTIFIER_NAME.

Default value: notify

api_key

(string)(Required)Your SendGrid API key.

sender

(string)(Required)The e-mail address of the sender.

recipient

(string)(Required)The recipient of the notification.

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