From 5b1b1fc40a74b66924e2748d7549973b8024c679 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 18 Nov 2018 09:09:16 +0100 Subject: [PATCH] Update sendgrid notify component configuration (#7569) --- source/_components/notify.sendgrid.markdown | 25 ++++++++++++++++----- 1 file changed, 19 insertions(+), 6 deletions(-) diff --git a/source/_components/notify.sendgrid.markdown b/source/_components/notify.sendgrid.markdown index b710dd1b3f2..887efaab788 100644 --- a/source/_components/notify.sendgrid.markdown +++ b/source/_components/notify.sendgrid.markdown @@ -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/).