SendGrid

SendGrid

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.

Prerequisites

• Medusa backend
• SendGrid account

How to Install

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

1
npm install medusa-plugin-sendgrid

2. Set the following environment variable in Copy to clipboard.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 Copy to clipboardmedusa-config.js add the following at the end of the Copy to clipboardplugins array:

123456789101112131415161718
const plugins = [
  // ...,
  {
    resolve: `medusa-plugin-sendgrid`,
    options: {
      api_key: process.env.SENDGRID_API_KEY,
      from: process.env.SENDGRID_FROM,
      order_placed_template: 
        process.env.SENDGRID_ORDER_PLACED_ID,
      localization: {
        "de-DE": { // locale key
          order_placed_template:
            process.env.SENDGRID_ORDER_PLACED_ID_LOCALIZED,
        },
      },
    },
  },
]

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