Medusa v2 Example: Notification Plugin

This plugin allows you to manually create notifications and assign them to specific users within Medusa.

Requirements

1. Node.js v20+
2. Git CLI
3. PostgreSQL

Installation

1. yarn add notification-plug # or npm install notification-plug
2. Add the plugin to the plugins array in medusa-config.ts:

module.exports = defineConfig({
  // ...
  plugins: [
    {
      resolve: "notification-plug",
      options: {},
    },
  ],
});

3. Run the db:migrate command to run migrations and sync links:

npx medusa db:migrate

Test it Out

To test this plugin, you can go to the Medusa Admin panel, open the "Notification" extension, and manually create or modify notifications for a user using their customer_id.

Storefront

Fetch all notifications assigned to the authenticated user.

• GET /store/notifications

Response example:

[
  {
    id: "01K6JETAE6833JRQ8VPKQDWS6T",
    image: "https://example.com/image.webp",
    link: "/store",
    published_at: "2025-10-02T12:37:10.215Z",
    status: "published",
    title: "New Promotion!",
    user_notification: {
      id: "01K6JZ2HEE96Q5QATM2RSY6HRD",
      notification_id: "01K6JETAE6833JRQ8VPKQDWS6T",
      read_at: null,
      user_id: "cus_01K6JQZYZBWPCED77J42R0J9EW",
    },
  },
];

Update the read status of a specific user notification.

• POST /store/notifications Request body:

{
  "id": "01K6JZ2HEE96Q5QATM2RSY6HRD",
  "read_at": "2025-10-02T17:31:38.158Z"
}

Description:

• id: The ID of the user_notification record.

• read_at: The date and time when the notification was read (set to null to mark it as unread).

Response example:

{
  "id": "01K6JZ2HEE96Q5QATM2RSY6HRD",
  "notification_id": "01K6JETAE6833JRQ8VPKQDWS6T",
  "read_at": "2025-10-02T17:31:38.158Z",
  "user_id": "cus_01K6JQZYZBWPCED77J42R0J9EW"
}

More Resources

Medusa Documentatin