jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-13 20:36:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update sendgrid notify component configuration (#7569)

Browse Source
This commit is contained in:
Klaas Schoute 2018-11-18 09:09:16 +01:00 committed by Fabian Affolter
parent 610efa0f50
commit 5b1b1fc40a
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
source/_components/notify.sendgrid.markdown
View File

@ -25,11 +25,24 @@ notify:
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.
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
api_key:
description: SendGrid API key - https://app.sendgrid.com/settings/api_keys
required: true
type: string
sender:
description: E-mail address of the sender.
required: true
type: string
recipient:
description: Recipient of the notification.
required: true
type: string
{% endconfiguration %}
To use notifications, please see the [getting started with automation page](/getting-started/automation/).