SendGridMailSend

Send an automated SendGrid email from a workflow.

yaml
type: "io.kestra.plugin.notifications.sendgrid.SendGridMailSend"

Examples

Send an email on a failed flow execution.

yaml

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*string

Min length1

The address of the sender of this email

sendgridApiKey*string

Min length1

The SendGrid API KEY

to*array

SubTypestring

Min items1

Email address(es) of the recipient(s)

attachmentsarray

Adds an attachment to the email message

The attachment will be shown in the email client as separate files available for download or display.inline if the client supports it (for example, most browsers display PDF's in a popup window)

Definitions

io.kestra.plugin.notifications.sendgrid.SendGridMailSend-Attachment

name*string

uri*string

contentTypestring

Defaultapplication/octet-stream

ccarray

SubTypestring

One or more 'Cc' (carbon copy) optional recipient(s) email address(es)

embeddedImagesarray

Adds image data to this email that can be referred to from the email HTML body

The provided images are assumed to be of MIME type png, jpg, or whatever the email client supports as valid image that can be embedded in HTML content.

Definitions

io.kestra.plugin.notifications.sendgrid.SendGridMailSend-Attachment

name*string

The name of the attachment (eg. 'filename.txt')

uri*string

An attachment URI from Kestra internal storage

contentTypestring

Defaultapplication/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.

htmlContentstring

The optional email message body in HTML

subjectstring

The optional subject of this email

textContentstring

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

bodystring

headersobject

SubTypestring

statusCodeinteger

Default0

Azure (EE)

Leverage Microsoft Azure services within Kestra data workflows.

AlertingCloudStorageBatch

ServiceNow

This sub-group of plugins contains tasks for using ServiceNow. ServiceNow allows employees to work the way they want to, not how software dictates they have to.

Alerting