SendGrid Resource
The SendGrid Resource makes it easy to perform actions using the SendGrid API (opens in a new tab).
Configuration Steps
- Once logged in to SendGrid, go to Settings on the left navigation bar, and select "API Keys".
- Click "Create API Key".
- Give your API key a name.
- Select Restricted Access.
- Select Full Access on Mail Send
- While you can provide a key with full permissions on everything, this is all we need to send email on your behalf.
- Click "Create & View".
- Copy your API key into Dynaboard.
- Secret fields (e.g. passwords or certificates) require clicking the ✓ to the right of the field to save the input.
Common Configuration Errors
- A secret may be unsaved (e.g. passwords or certificates). Click the ✓ to the right of the field to save it. The text will disappear after a successful save.
- Sender Authentication hasn't been properly setup in your SendGrid account for the email you're trying to send from.
Properties
Environment Profiles
| Prop | profiles |
|---|---|
| Type | array |
| Default | [ { 'environment': '' } ] |
The profiles configured for this resource in an environment
Environment Profile
| Prop | profiles[] |
|---|---|
| Type | object |
| Default | undefined |
A profile of this resource for an environment
SendGrid API Key
| Prop | profiles[].apiKey |
|---|---|
| Type | ({ ref: string } | undefined) |
| Default | undefined |
The API key to use when connecting to the SendGrid API.
Environment
| Prop | profiles[].environment |
|---|---|
| Type | string |
| Default | undefined |
The name of the environment with which this profile is associated
Actions
Send Email
Sends an email using the SendGrid API.
| Parameter | Type | Default |
|---|---|---|
from | string | undefined |
to | string | undefined |
cc | string | undefined |
bcc | string | undefined |
replyTo | string | undefined |
subject | string | undefined |
contentType | EmailContentType ("text/plain" | "text/html") | text/html |
content | string | undefined |