Email by SendGrid Post-run Action
The Email by SendGrid Post-run action plugin is available in the Hub. This plugin may incur additional charges depending on usage within the pipeline. More Info.
The Email by Sendgrid post-action can be used to send an email at the end of a pipeline run. You can configure it to send an email when the pipeline completes, succeeds or fails. For example, you may want to configure a pipeline so that an email is sent whenever the run failed for any reason.
Uses the Sendgrid service to send emails, and requires you to sign up for a Sendgrid account.
Configuration
Property | Macro Enabled? | Description |
|---|---|---|
Run Condition | No | Optional. When to run the action. Must be 'completion', 'success', or 'failure'. Defaults to 'completion'. If set to 'completion', the action will be executed regardless of whether the pipeline run succeeded or failed. If set to 'success', the action will only be executed if the pipeline run succeeded. If set to 'failure', the action will only be executed if the pipeline run failed. |
API Key | Yes | Required. The SendGrid API Key. After logging into your Sendgrid account, you can create a key in the API keys section of the Settings page. |
From | Yes | Required. The address to send the email from. |
To | Yes | Required. The address to send the email to. |
Subject | Yes | Required. The subject of the email. |
Content | Yes | Optional. Optional content of the email. Defaults to empty. |
Include Workflow Token | Yes | Workflow tokens contain data such as counters, statuses and metrics, that are passed between the nodes of a pipeline. This config determines whether to include the contents of the workflow token in the email message. Default is No. |
Example
This example sends an email from 'team-ops@example.com' to 'team-alerts@example.com' whenever a run fails:
Property | Value |
|---|---|
Run Condition |
|
API Key |
|
From |
|
To |
|
Subject |
|
Content |
|
Include Workflow Token |
|
Created in 2020 by Google Inc.