Sendgrid
SendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.
SendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.
Category: Communication. Adds 6 actions to a care flow.
What to configure
Set these once, on the extension in Awell Studio. An action fails at run time if a required setting is missing.
| Setting | Required | Notes |
|---|---|---|
| API Key | Yes | Your Sendgrid API Key so the extension can authenticate with the Sendgrid API. Stored as a secret. |
| From email | No | The email address that will be used for the "From" header. |
| From name | No | The name that will be used for the "From" header. |
Actions
Sendgrid adds these 6 actions to a care flow. Add one to a step, then fill in its inputs.
Add or update contact
Add or update contact
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| List IDs | string | Yes | A comma-separated string of list IDs the contact will be added to. |
string | Yes | The contact's primary email. | |
| First Name | string | No | The contact's first name. |
| Last Name | string | No | The contact's last name. |
| Custom fields | json | No | An object of custom field IDs and the values you want to associate with those custom fields. |
Returns:
| Data point | Type |
|---|---|
jobId | string |
Allows adding or updating contacts. The contact to update will be determined only by the email field and any fields omitted from the request will remain as they were. A contact's ID cannot be used to update the contact.
Please note that custom fields need to have been already created if you wish to set their values for the contacts being upserted. To do this, please use the "Create Custom Field Definition" endpoint. They also can be created in Marketing -> Custom Fields section in Sendgrid.
Add Email to Suppression Lists
Adds an email to one or more suppression lists.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
string | Yes | The email address you would like to suppress | |
| Groups | string | Yes | A comma-separated list of group IDs (e.g. 12345, 12346) |
Status of Import
Get the status of an Import job
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
| Job ID | string | Yes | The ID of the Sendgrid Job (usually obtained from the Add or Update Contact action) |
| Wait for finished | boolean | No | If true, the action will wait for the import job to finish before completing. |
Returns:
| Data point | Type |
|---|---|
finishedAt | date |
id | string |
importStatus | string |
jobType | string |
startedAt | date |
Remove Email from Suppression Lists
Remove an email address from one or more suppression lists.
This action can be previewed in Studio before you publish.
| Input | Type | Required | Description |
|---|---|---|---|
string | Yes | The email address you would like to remove from the suppression list | |
| Groups | string | Yes | A comma-separated list of group IDs (e.g. 12345, 12346) |
Send email
Send an email.
| Input | Type | Required | Description |
|---|---|---|---|
| From name | string | No | The name that will be used for the "From" header. When left blank, the value specified in the extension settings will be used. |
| From email | string | No | The email address that will be used for the "From" header. When left blank, the value specified in the extension settings will be used. |
| To | string | Yes | The email address of the recipient. |
| Subject | string | Yes | The subject of your email. |
| Body | html | Yes | The content of your message. |
Allows for sending a plain email to a recipient.
Send email with template
Send an email based on a template to a recipient of your choice.
| Input | Type | Required | Description |
|---|---|---|---|
| From name | string | No | The name that will be used for the "From" header. When left blank, the value specified in the extension settings will be used. |
| From email | string | No | The email address that will be used for the "From" header. When left blank, the value specified in the extension settings will be used. |
| To | string | Yes | The email address of the recipient. |
| Template ID | string | Yes | The immutable ID of a template that exists in your account. |
| Subject | string | No | The subject of your email. If you would like to compose a dynamic subject line then pass a subject field with the template content below. |
| Template content | json | No | Specify a JSON blob containing the dynamic data of your template. Read the Sendgrid documentation to learn more about dynamic template data. |
Setup and notes
SendGrid is a cloud-based email delivery platform that provides services for sending and managing email campaigns, transactional emails, and other types of messages.
Extension settings
In order to set up this extension, you will need to provide:
- An API key
- A from name
- A from email
Send email with a template
Allows for sending an email based on a template to a recipient. You can also insert variables so they are rendered in your template.
Add and remove emails from suppression lists
Suppression lists (link on SendGrid's website) are unsubscribe groups. Use these actions to add an email address to any number of unsubscribe groups. You can apply a suppression add/remove to multiple groups by using comma-separated lists for the groups. Only a single email can be used. This functionality is different from SendGrid's API, which allows multiple email addresses for a single group.
Check an import status
Allows user to check the status of contact import jobs when given a jobID. Statuses are either: pending, completed, failed, or errored.
Changelog
July 7, 2023
Added "Add Email to Suppression Lists" and "Remove Email from Suppression Lists" actions.
July 15, 2023
Updated "Add or Update Contact" acction to create a datapoint of the Job ID.
Added "Check Import Status" action.
July 27, 2023
Adds "Finished At" data point to the importStatus action.
Where this page comes from
The settings, actions, inputs, outputs and webhooks above are generated from the
extension's own code, at @awell-health/awell-extensions v2.1.159. They match what the
platform actually does rather than a description of it.
Field-level detail also appears in Awell Studio when you configure the action. Something wrong or missing? Email support@awellhealth.com.