SendGridMailSend
Send an automated SendGrid email from a workflow.
type: "io.kestra.plugin.notifications.sendgrid.SendGridMailSend"
Examples
Send an email on a failed flow execution.
id: unreliable_flow
namespace: company.team
tasks:
- id: fail
type: io.kestra.plugin.scripts.shell.Commands
runner: PROCESS
commands:
- exit 1
errors:
- id: send_email
type: io.kestra.plugin.notifications.sendgrid.SendGridMailSend
from: [email protected]
to:
- [email protected]
sendgridApiKey: "{{ secret('SENDGRID_API_KEY') }}"
subject: "Kestra workflow failed for the flow {{flow.id}} in the namespace {{flow.namespace}}"
htmlTextContent: "Failure alert for flow {{ flow.namespace }}.{{ flow.id }} with ID {{ execution.id }}"
Properties
from *Requiredstring
1
The address of the sender of this email
sendgridApiKey *Requiredstring
1
The SendGrid API KEY
to *Requiredarray
1
Email address(es) of the recipient(s)
Note that each email address must be compliant with the RFC2822 format.
attachments Non-dynamicarray
cc array
One or more 'Cc' (carbon copy) optional recipient(s) email address(es)
Note that each email address must be compliant with the RFC2822 format.
embeddedImages Non-dynamicarray
htmlContent string
The optional email message body in HTML
Both text and HTML can be provided, either will be offered to the email client as alternative content.Email clients that support it, will favor HTML over plain text and ignore the text body completely.
subject string
The optional subject of this email
textContent string
The optional email message body in plain text
Both text and HTML can be provided, either will be offered to the email client as alternative content.Email clients that support it, will favor HTML over plain text and ignore the text body completely.
Outputs
body string
headers object
statusCode integer
0
Definitions
io.kestra.plugin.notifications.sendgrid.SendGridMailSend-Attachment
name *Requiredstring
The name of the attachment (eg. 'filename.txt')
uri *Requiredstring
An attachment URI from Kestra internal storage
contentType string
application/octet-stream
One or more 'Cc' (carbon copy) optional recipient email address(es). Use semicolon as a delimiter to provide several addresses.
Note that each email address must be compliant with the RFC2822 format.