D
Discord
Отправляйте уведомления в Discord через вебхуки по событиям магазина Medusa, с динамическими настройками.
npm install @sam-ael/medusa-plugin-discord
Категория
Создано
Версия
0.2.1
Последнее обновление
3 месяца назад
Ежемесячные загрузки
Загрузка данных
Звезды на Github
1
@sam-ael/medusa-plugin-discord
A Discord webhook notification plugin for Medusa v2. Route store events to your Discord channels with rich embed cards that automatically update in-place as order status changes — from placed → fulfilled → shipped → completed or canceled.
Features
- Live Message Editing — One message per order, edited in place as status changes. No channel spam.
- Shipment & Tracking — Displays tracking numbers and links as clickable Discord markdown when an order is shipped.
- Premium Rich Embeds — Beautiful default embed cards with color-coded status badges (🟡 Pending → 🚚 Shipped → 🟢 Completed → 🔴 Canceled).
- Custom Markdown Templates — Write your own message templates using Discord Markdown with .
- Configurable Bot Name — Set a global fallback bot name via plugin config or env var, and override per-channel from the Admin UI.
- Interactive Admin UI — Manage all webhook mappings and templates directly from the Medusa Admin panel settings.
- Placeholder Sidebar — Click a field (e.g. , ) to insert it at your cursor in the template editor.
- Price Formatting — Automatically converts price fields from Medusa's integer cents to human-readable decimals.
- Multiple Event Triggers — Supports order, fulfillment, shipment, and customer events.
Installation
Setup
1. Add to
2. Set Environment Variables (Optional)
3. Run Migrations
npx medusa db:migrateAdmin UI
Navigate to Settings → Discord Notifications in the Medusa Admin panel.
Webhook Mapping Fields
| Field | Required | Description |
|---|---|---|
| Event Trigger | ✅ | Which Medusa event fires this webhook |
| Discord Webhook URL | ✅ | Full Discord webhook URL |
| Channel Label | ❌ | Friendly label (e.g. ) — display only |
| Bot Name | ❌ | Override the bot's display name for this channel. Falls back to plugin option → |
| Custom Message Template | ❌ | Discord Markdown template. Leave blank for default rich embed. |
| Enabled | ✅ | Toggle to activate/deactivate without deleting |
Message Lifecycle (In-Place Editing)
The plugin stores the Discord returned when an order notification is first posted. All subsequent events for the same order edit that same message rather than posting new ones.
If the original Discord message is manually deleted, the plugin automatically posts a fresh message and saves the new .
Supported Events
| Event | Description |
|---|---|
| New order placed | |
| Fulfillment created for an order | |
| Shipment created with tracking info | |
| Order marked as completed | |
| Order canceled | |
| Order updated | |
| New customer registered | |
| Customer profile updated |
Template Placeholders
Order Events
| Placeholder | Description |
|---|---|
| Order ID | |
| Human-readable order number | |
| Order status | |
| Order total (formatted as decimal) | |
| Subtotal (formatted as decimal) | |
| Currency code (e.g. ) | |
| Customer email | |
| Payment status | |
| Fulfillment status | |
| , , or | |
| Comma-separated tracking numbers | |
| Tracking numbers as clickable Discord markdown links | |
| Shipping first name | |
| Shipping last name | |
| Shipping city | |
| Customer account email |
Customer Events
| Placeholder | Description |
|---|---|
| Customer ID | |
| Email address | |
| First name | |
| Last name | |
| Phone number |
Plugin Options
Admin API Reference
| Method | Endpoint | Description |
|---|---|---|
| List all webhook mappings | ||
| Create a new webhook mapping | ||
| Update a webhook mapping | ||
| Delete a webhook mapping | ||
| Send a test notification using mock data |
Mapping Payload
Development
License
MIT