SendGrid

This is a modified version of the original Sendgrid plugin as the medusa team is not responsive to my pull request

This plugin is rewritten in typescript and added some extra features.

Handle sending emails to customers related to orders, restock notifications, users, or custom events.

SendGrid Plugin Documentation | Medusa Website | Medusa Repository

Features

Send emails when an event related to orders, restock notifications, or users is triggered.
Use dynamic templates in SendGrid to build the emails to be sent.
Send emails with SendGrid for custom events.

Extra features:

BCC to a specific email addresses when order is placed if you want to send yourself the order and for example TrustPilot
Typescript support
Custom subject with dynamic data

Prerequisites

How to Install

1. Run the following command in the directory of the Medusa backend:

1
  npm install medusa-plugin-sendgrid-typescript

1
  yarn add medusa-plugin-sendgrid-typescript

2. Set the following environment variable in .env:

1234
  SENDGRID_API_KEY=<API_KEY>
  SENDGRID_FROM=<SEND_FROM_EMAIL>
  # IDs for different email templates
  SENDGRID_ORDER_PLACED_ID=<ORDER_PLACED_TEMPLATE_ID> # example

3. In medusa-config.js add the following at the end of the plugins array:

1234567891011121314151617181920212223242526
  const plugins = [
    // ...,
    {
      resolve: `medusa-plugin-sendgrid-typescript`,
      /** @type {import('medusa-plugin-sendgrid-typescript').PluginOptions} */
      options: {
        api_key: process.env.SENDGRID_API_KEY,
        from: process.env.SENDGRID_FROM,
        templates: {
          order_placed_template: {
            id: process.env.SENDGRID_ORDER_PLACED_ID,
            // You can add dynamic data to the template by using {variable_name}
            subject: "Thank you for your order #{display_id}!",
          },
        },
        localization: {
          "de-DE": { // locale key
            order_placed_template: {
              subject: "Danke für Ihre Bestellung #{display_id}!",
              id: process.env.SENDGRID_ORDER_PLACED_ID,
            }
          },
        },
      },
    },
  ]

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:

1
  npm run start

2. Place an order using a storefront or the Store APIs. You should receive a confirmation email.

Additional Resources

SendGrid Plugin Documentation

Build your own plugins

Develop your own plugins with our API to speed up your processes.

Make your plugin available via npm for it to be shared in our Plugin Library with the broader Medusa community.

Built by

Category

Version