N

Notification sendgrid

Name: Notification sendgrid
Author: Medusa

Sendgrid notification provider for Medusa

Included in @medusajs/medusa, no separate install needed

@medusajs/notification-sendgrid

Documentation | Website

Building blocks for digital commerce

SendGrid Notification Module Provider for Medusa: sends email notifications through SendGrid, using SendGrid dynamic templates or raw HTML content. Use it to send transactional emails, such as order confirmations or password resets. It ships with and is registered through the path.

At a glance


Package
Type	Module Provider (Notification Module)
Provider ID
Registered by default	No
Import from

Features

Sends a notification's as a SendGrid dynamic template ID, with the notification's as the template data.
Sends a notification's ( and ) instead of a template when it's set.
Supports attachments, a per-notification address, and SendGrid through .

Installation

No installation needed. The provider is a dependency of .

Usage

Register the provider in the Notification Module's array in for the channel. Each channel can be handled by only one provider.

1import { defineConfig } from "@medusajs/framework/utils"
2
3module.exports = defineConfig({
// ...
modules: [
  {
    resolve: "@medusajs/medusa/notification",
    options: {
      providers: [
        {
          resolve: "@medusajs/medusa/notification-sendgrid",
          id: "sendgrid",
          options: {
            channels: ["email"],
            api_key: process.env.SENDGRID_API_KEY,
            from: process.env.SENDGRID_FROM,
          },
        },
      ],
    },
  },
],
23})

Configuration

Option	Type	Description	Default
		Read by the Notification Module. The channels this provider handles; use .
		Required. Your SendGrid API key.	-
		Required. The default sender email address.	-