• Reference
  • Nodes
  • Resources
  • SendGrid

SendGrid Resource

The SendGrid Resource makes it easy to perform actions using the SendGrid API.

Configuration Steps

  1. Once logged in to SendGrid, go to Settings on the left navigation bar, and select "API Keys".
  2. Click "Create API Key".
  3. Give your API key a name.
  4. Select Restricted Access.
  5. 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.
  6. Click "Create & View".
  7. 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

Propprofiles
Typearray
Default[ { 'environment': '' } ]

The profiles configured for this resource in an environment

Environment Profile

Propprofiles[]
Typeobject

A profile of this resource for an environment

SendGrid API Key

Propprofiles[].apiKey
Type({ ref: string } | undefined)

The API key to use when connecting to the SendGrid API.

Environment

Propprofiles[].environment
Typestring

The name of the environment with which this profile is associated

Actions

Send Email

Sends an email using the SendGrid API.

ParameterTypeDefault
fromstringundefined
tostringundefined
ccstringundefined
bccstringundefined
replyTostringundefined
subjectstringundefined
contentTypeEmailContentType ("text/plain" | "text/html")text/html
contentstringundefined
Last updated on November 1, 2022