A comprehensive automation plugin for Medusa v2 that provides a flexible rule-based automation system with triggers, conditions, and actions. Create automated workflows that can send notifications (email, Slack), execute custom actions, or trigger other processes based on events, schedules, or manual triggers with customizable rules.
Features
Automation Triggers: Create automations triggered by events, schedules, or manual actions (see details)
Rule-Based Conditions: Define complex conditions with support for arrays, relations, and multiple data types (see details)
Rich Attribute Support: Pre-configured attributes for Products, Variants, Tags, Categories, and Inventory (see available attributes)
Multiple Action Types: Execute various actions including email notifications, Slack messages, SMS, push notifications, and custom actions (see details)
Event Subscribers: Built-in subscribers for common Medusa events (see available events)
Admin Panel: Manage automations directly from Medusa Admin (see details)
Extensible: Add custom action handlers and extend automation capabilities
Type-Safe: Full TypeScript support with exported types and workflows
Compatibility
Medusa Version:
Node Version:
Installation
npm install @codee-sh/medusa-plugin-automations
# or
yarn add @codee-sh/medusa-plugin-automations
Quick Start
1. Register the Plugin
Add to your :
module.exports =defineConfig({
plugins:[
"@codee-sh/medusa-plugin-automations"
]
})
2. Run Migrations
The plugin includes database migrations for automation models. Run migrations to set up the required tables:
Navigate to Notifications > Automations in your Medusa Admin dashboard, or directly access:
How It Works
Automation Triggers
Automations are triggered by:
Events: Medusa events (e.g., , )
Schedule: Time-based triggers with configurable intervals (In progress)
Manual: Triggered manually from the admin panel
See Available Subscribers in the configuration documentation for a complete list of supported events.
Rules and Conditions
Each automation can have multiple rules that define when actions should be executed. Rules support primitive fields, relations (arrays), nested objects, and various operators for complex conditions.