Integration Module 2.0 for Medusa is outRead the announcement
Webhooks logo

Webhooks

Configure and manage outgoing webhooks

npm install @lambdacurry/medusa-webhooks
Category
Built by
Version
1.2.0
Last updated
8 months ago
Monthly downloads
Loading downloads

@lambdacurry/medusa-webhooks

Add webhook functionality to your Medusa e-commerce server, allowing you to send real-time notifications to external services when specific events occur in your system. The plugin seamlessly integrates with Medusa's event system and provides a simple way to manage webhooks for various events.

Features

  • Event-Based Webhooks: Automatically trigger webhooks based on Medusa events like product creation, updates, and more
  • Flexible Configuration: Easy setup and configuration through Medusa's plugin system
  • Built-in Event Support: Pre-configured support for common Medusa events
  • Workflow Integration: Seamlessly integrates with Medusa's workflow system for reliable webhook processing

Installation

  1. Install the plugin using your preferred package manager:
  1. Add the plugin to your :
  1. Run migrations:
yarn medusa db:migrate

Usage

Creating a Webhook Subscriber

The plugin provides three different workflows for handling webhooks:

  1. : Retrieves active webhook subscriptions for a specific event
  2. : Sends webhook events to the subscribed endpoints
  3. : Combines both workflows to handle the complete webhook process

Here's an example of how to use these workflows in your subscriber:

Development

To contribute to this plugin:

  1. Clone the repository
  2. Install dependencies:
  3. Run the plugin:

Please read more about how to run the plugin in dev mode: https://docs.medusajs.com/learn/fundamentals/plugins/create

License

MIT License