Slack

Receive new order notifications on Slack.

Slack Plugin Documentation | Medusa Website | Medusa Repository

Features

Receive details about new orders including purchased items, totals, customer information, and more.

Prerequisites

How to Install

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

1
  npm install medusa-plugin-slack-notification

2. Set the following environment variable in .env:

12
  SLACK_WEBHOOK_URL=<YOUR_SLACK_WEBHOOK_URL>
  SLACK_ADMIN_ORDERS_URL=<YOUR_ADMIN_ORDERS_URL>

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

1234567891011
  const plugins = [
    // ...,
    {
      resolve: `medusa-plugin-slack-notification`,
      options: {
        show_discount_code: false, // optional, whether the discount code should be shown in notifications
        slack_url: process.env.SLACK_WEBHOOK_URL,
        admin_orders_url: process.env.SLACK_ADMIN_ORDERS_URL, // for example, http://localhost:7001/a/orders
      },
    },
  ]

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 notification on your Slack workspace.

Additional Resources

Slack 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