Send Email Single Recipient with Twilio SendGrid API

Pipedream makes it easy to connect APIs for Twilio SendGrid and 2,000+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Send Email Single Recipient with the Twilio SendGrid API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Send Email Single Recipient with the Twilio SendGrid API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Send Email Single Recipient action
1. Connect your Twilio SendGrid account
2. Select a From Email
3. Optional- Configure From Name
4. Configure To Email
5. Optional- Configure To Name
6. Optional- Configure CC
7. Optional- Configure BCC
8. Optional- Configure Personalization.Headers
9. Optional- Configure Substitutions
10. Optional- Configure Dynamic Template Data
11. Optional- Select a Template ID
12. Optional- Configure Reply To Email
13. Optional- Configure Reply To Name
14. Configure Subject
15. Optional- Configure Content
16. Optional- Configure Attachments
17. Optional- Configure Headers
18. Optional- Configure Categories
19. Optional- Configure Custom Args
20. Optional- Configure Send At
21. Optional- Configure ASM
22. Optional- Select a ASM Group ID
23. Optional- Select one or more ASM Groups to Display
24. Optional- Configure IP Pool Name
25. Optional- Configure Mail Settings
26. Optional- Configure Tracking Settings
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Send Email Single Recipient with Twilio SendGrid API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Twilio SendGrid

Try it

Send Email Single Recipient with Twilio SendGrid API on New Message from Discord API

Discord + Twilio SendGrid

Try it

Send Email Single Recipient with Twilio SendGrid API on New Message In Channels from Slack API

Slack + Twilio SendGrid

Try it

Send Email Single Recipient with Twilio SendGrid API on New Message in Channel from Discord Bot API

Discord Bot + Twilio SendGrid

Try it

Send Email Single Recipient with Twilio SendGrid API on New Submission from Typeform API

Typeform + Twilio SendGrid

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Send Email Single Recipient on Twilio SendGrid

Description:This action sends a personalized e-mail to the specified recipient. [See the docs here](https://docs.sendgrid.com/api-reference/mail-send/mail-send)

Version:0.0.6

Key:sendgrid-send-email-single-recipient

View on GitHub

Code#

import validate from "validate.js";
import common from "../common/common.mjs";

export default {
  ...common,
  key: "sendgrid-send-email-single-recipient",
  name: "Send Email Single Recipient",
  description: "This action sends a personalized e-mail to the specified recipient. [See the docs here](https://docs.sendgrid.com/api-reference/mail-send/mail-send)",
  version: "0.0.6",
  type: "action",
  props: {
    ...common.props,
    fromEmail: {
      propDefinition: [
        common.props.sendgrid,
        "fromEmail",
      ],
    },
    fromName: {
      propDefinition: [
        common.props.sendgrid,
        "fromName",
      ],
    },
    toEmail: {
      type: "string",
      label: "To Email",
      description: "The intended recipient's email address",
    },
    toName: {
      type: "string",
      label: "To Name",
      description: "The intended recipient's name",
      optional: true,
    },
    cc: {
      type: "string",
      label: "CC",
      description:
        "An array of recipients who will receive a copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recipient's name. Alternatively, provide a string that will `JSON.parse` to an array of recipient objects. Example: `[{\"email\":\"email@example.com\",\"name\":\"Example Recipient\"}]`",
      optional: true,
    },
    bcc: {
      type: "string",
      label: "BCC",
      description: "An array of recipients who will receive a blind copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recpient's name. Alternatively, provide a string that will `JSON.parse` to an array of recipient objects. Example: `[{\"email\":\"email@example.com\",\"name\":\"Example Recipient\"}]`",
      optional: true,
    },
    personalizationHeaders: {
      type: "object",
      label: "Personalization.Headers",
      description: "An object containing key/value pairs allowing you to specify handling instructions for your email. You may not overwrite the following headers: `x-sg-id`, `x-sg-eid`, `received`, `dkim-signature`, `Content-Type`, `Content-Transfer-Encoding`, `To`, `From`, `Subject`, `Reply-To`, `CC`, `BCC`.",
      optional: true,
    },
    substitutions: {
      type: "string",
      label: "Substitutions",
      description: "Substitutions allow you to insert data without using Dynamic Transactional Templates. This field should not be used in combination with a Dynamic Transactional Template, which can be identified by a `template_id` starting with `d-`. This field is a collection of key/value pairs following the pattern `\"substitution_tag\":\"value to substitute\"`. The key/value pairs must be strings. These substitutions will apply to the text and html content of the body of your email, in addition to the `subject` and `reply-to` parameters. The total collective size of your substitutions may not exceed 10,000 bytes per personalization object.",
      optional: true,
    },
    dynamicTemplateData: {
      type: "object",
      label: "Dynamic Template Data",
      description: "Dynamic template data is available using Handlebars syntax in Dynamic Transactional Templates. This field should be used in combination with a Dynamic Transactional Template, which can be identified by a template_id starting with d-. This field is a collection of key/value pairs following the pattern `\"variable_name\":\"value to insert\"`",
      optional: true,
    },
    templateId: {
      propDefinition: [
        common.props.sendgrid,
        "templateId",
      ],
      optional: true,
    },
    replyToEmail: {
      propDefinition: [
        common.props.sendgrid,
        "replyToEmail",
      ],
    },
    replyToName: {
      propDefinition: [
        common.props.sendgrid,
        "replyToName",
      ],
    },
    subject: {
      propDefinition: [
        common.props.sendgrid,
        "subject",
      ],
    },
    content: {
      propDefinition: [
        common.props.sendgrid,
        "content",
      ],
      optional: true,
    },
    attachments: {
      propDefinition: [
        common.props.sendgrid,
        "attachments",
      ],
    },
    headers: {
      propDefinition: [
        common.props.sendgrid,
        "headers",
      ],
    },
    categories: {
      propDefinition: [
        common.props.sendgrid,
        "categories",
      ],
    },
    customArgs: {
      propDefinition: [
        common.props.sendgrid,
        "customArgs",
      ],
    },
    sendAt: {
      propDefinition: [
        common.props.sendgrid,
        "sendAt",
      ],
    },
    asm: {
      propDefinition: [
        common.props.sendgrid,
        "asm",
      ],
    },
    asmGroupId: {
      propDefinition: [
        common.props.sendgrid,
        "asmGroupId",
      ],
    },
    asmGroupsToDisplay: {
      propDefinition: [
        common.props.sendgrid,
        "asmGroupsToDisplay",
      ],
    },
    ipPoolName: {
      propDefinition: [
        common.props.sendgrid,
        "ipPoolName",
      ],
    },
    mailSettings: {
      propDefinition: [
        common.props.sendgrid,
        "mailSettings",
      ],
    },
    trackingSettings: {
      propDefinition: [
        common.props.sendgrid,
        "trackingSettings",
      ],
    },
  },
  async run({ $ }) {
    //Performs validation on parameters.
    validate.validators.arrayValidator = this.validateArray; //custom validator for object arrays
    validate.validators.asmValidator = this.validateAsm; //custom validator for asm object
    //Defines constraints for required parameters
    const constraints = {
      toEmail: {
        email: true,
      },
      fromEmail: {
        email: true,
      },
    };
    //Defines constraints for optional parameters
    if (this.cc) {
      constraints.cc = {
        arrayValidator: {
          value: this.cc,
          key: "recipient",
        },
      };
    }
    if (this.bcc) {
      constraints.bcc = {
        arrayValidator: {
          value: this.bcc,
          key: "recipient",
        },
      };
    }
    if (this.asm || this.asmGroupsToDisplay) {
      constraints.asm = {
        asmValidator: {
          asm: this.asm,
          asmGroupId: this.asmGroupId,
          asmGroupsToDisplay: this.asmGroupsToDisplay,
        },
      };
    }
    let attachments = this.convertEmptyStringToUndefined(this.attachments);
    if (this.attachments) {
      constraints.attachments = {
        arrayValidator: {
          value: this.attachments,
          key: "attachments",
        },
      };
      attachments = this.getArrayObject(this.attachments);
    }
    if (this.categories) {
      constraints.categories = {
        type: "array",
      };
    }
    if (this.replyToEmail) {
      constraints.replyToEmail = {
        email: true,
      };
    }
    this.sendAt = this.convertEmptyStringToUndefined(this.sendAt);
    if (this.sendAt != null) {
      constraints.sendAt = this.getIntegerGtZeroConstraint();
    }
    //Executes validation
    const validationResult = validate(
      {
        toEmail: this.toEmail,
        cc: this.cc,
        bcc: this.bcc,
        fromEmail: this.fromEmail,
        replyToEmail: this.replyToEmail,
        attachments: this.attachments,
        categories: this.categories,
        sendAt: this.sendAt,
      },
      constraints,
    );
    this.checkValidationResults(validationResult);
    //Set ups the `personalizations` object, where `to`, `cc`, and `bcc` recipients are specified,
    //with `to` being required.
    const personalizations = [
      {},
    ];
    personalizations[0].to = [
      {
        email: this.toEmail,
      },
    ];
    if (this.toName) {
      personalizations[0].to[0].name = this.toName;
    }
    if (this.cc) {
      const ccArray = this.getArrayObject(this.cc);

      if (ccArray?.length) {
        personalizations[0].cc = ccArray;
      }
    }
    if (this.bcc) {
      const bccArray = this.getArrayObject(this.bcc);

      if (bccArray?.length) {
        personalizations[0].bcc = bccArray;
      }
    }
    if (this.personalizationHeaders) {
      personalizations[0].headers = this.convertEmptyStringToUndefined(this.personalizationHeaders);
    }
    if (this.substitutions) {
      personalizations[0].substitutions = this.substitutions;
    }
    if (this.dynamicTemplateData) {
      personalizations[0].dynamic_template_data = this.dynamicTemplateData;
    }
    //Set ups the `from` object, where `email`, `name` of the mail sender are specified, with
    //`email` being required.
    const from = {
      email: this.fromEmail,
    };
    if (this.fromName) {
      from.name = this.fromName;
    }
    //Set ups the `reply_to` object, where `email`, `name` of the reply-to recipient are
    //specified, with `email` being required.
    let replyTo = undefined;
    if (this.replyToEmail) {
      replyTo = {
        email: this.replyToEmail,
      };
      if (this.replyToName) {
        replyTo.name = this.replyToName;
      }
    }

    //Prepares and sends the request configuration
    const config = this.omitEmptyStringValues({
      personalizations,
      from,
      reply_to: replyTo,
      subject: this.subject,
      content: this.content && [
        {
          type: "text/html",
          value: this.content,
        },
      ],
      attachments,
      headers: this.headers,
      categories: this.categories,
      custom_args: this.customArgs,
      send_at: this.sendAt,
      asm: this.getAsmConfig(),
      ip_pool_name: this.ipPoolName,
      mail_settings: this.mailSettings,
      tracking_settings: this.trackingSettings,
      template_id: this.templateId,
    });
    const resp = await this.sendgrid.sendEmail(config);
    $.export("$summary", "Email successfully sent");
    return resp;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid app.
From Email	`fromEmail`	`string`	Select a value from the drop down menu.
From Name	`fromName`	`string`	A name or title associated with the sending email address
To Email	`toEmail`	`string`	The intended recipient's email address
To Name	`toName`	`string`	The intended recipient's name
CC	`cc`	`string`	An array of recipients who will receive a copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recipient's name. Alternatively, provide a string that will `JSON.parse` to an array of recipient objects. Example: `[{"email":"email@example.com","name":"Example Recipient"}]`
BCC	`bcc`	`string`	An array of recipients who will receive a blind copy of your email. Each object in this array must contain the recipient's email address. Each object in the array may optionally contain the recpient's name. Alternatively, provide a string that will `JSON.parse` to an array of recipient objects. Example: `[{"email":"email@example.com","name":"Example Recipient"}]`
Personalization.Headers	`personalizationHeaders`	`object`	An object containing key/value pairs allowing you to specify handling instructions for your email. You may not overwrite the following headers: `x-sg-id`, `x-sg-eid`, `received`, `dkim-signature`, `Content-Type`, `Content-Transfer-Encoding`, `To`, `From`, `Subject`, `Reply-To`, `CC`, `BCC`.
Substitutions	`substitutions`	`string`	Substitutions allow you to insert data without using Dynamic Transactional Templates. This field should not be used in combination with a Dynamic Transactional Template, which can be identified by a `template_id` starting with `d-`. This field is a collection of key/value pairs following the pattern `"substitution_tag":"value to substitute"`. The key/value pairs must be strings. These substitutions will apply to the text and html content of the body of your email, in addition to the `subject` and `reply-to` parameters. The total collective size of your substitutions may not exceed 10,000 bytes per personalization object.
Dynamic Template Data	`dynamicTemplateData`	`object`	Dynamic template data is available using Handlebars syntax in Dynamic Transactional Templates. This field should be used in combination with a Dynamic Transactional Template, which can be identified by a template_id starting with d-. This field is a collection of key/value pairs following the pattern `"variable_name":"value to insert"`
Template ID	`templateId`	`string`	Select a value from the drop down menu.
Reply To Email	`replyToEmail`	`string`	The email address where any replies or bounces will be returned
Reply To Name	`replyToName`	`string`	A name or title associated with the `replyToEmail` address
Subject	`subject`	`string`	The global or `message level` subject of your email
Content	`content`	`string`	Content of the email in `text/html`
Attachments	`attachments`	`string`	An array of objects where you can specify any attachments you want to include. The fields `content` and `filename` are required. `content` must be base64 encoded. Alternatively, provide a string that will `JSON.parse` to an array of attachments objects. Example: `[{content:"aGV5",type:"text/plain",filename:"sample.txt"}]`
Headers	`headers`	`object`	An object containing key/value pairs of header names and the value to substitute for them. The key/value pairs must be strings. You must ensure these are properly encoded if they contain unicode characters. These headers cannot be one of the reserved headers.
Categories	`categories`	`string[]`	A string array of category names for this message. Each category name may not exceed 255 characters. Example: `["category1","category2"]`
Custom Args	`customArgs`	`string`	Values that are specific to the entire send that will be carried along with the email and its activity data. Key/value pairs must be strings. Substitutions will not be made on custom arguments, so any string that is entered into this parameter will be assumed to be the custom argument that you would like to be used. This parameter is overridden by `custom_args` set at the personalizations level. Total `custom_args` size may not exceed 10,000 bytes.
Send At	`sendAt`	`integer`	A unix timestamp allowing you to specify when you want your email to be delivered. This may be overridden by the `send_at` parameter set at the personalizations level. Delivery cannot be scheduled more than 72 hours in advance. If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid peak times — for example, scheduling at 10:53 — can result in lower deferral rates due to the reduced traffic during off-peak times.
ASM	`asm`	`object`	Advanced Suppression Manager. An object allowing you to specify how to handle unsubscribes
ASM Group ID	`asmGroupId`	`integer`	Select a value from the drop down menu.
ASM Groups to Display	`asmGroupsToDisplay`	`integer[]`	Select a value from the drop down menu.
IP Pool Name	`ipPoolName`	`string`	The IP Pool that you would like to send this email from
Mail Settings	`mailSettings`	`object`	A collection of different mail settings that you can use to specify how you would like this email to be handled
Tracking Settings	`trackingSettings`	`object`	Settings to determine how you would like to track the metrics of how your recipients interact with your email