Integration Module 2.0 for Medusa is outRead the announcement
Whatsapp logo

Whatsapp

Send WhatsApp Business template messages on Medusa store events.

npm install @sam-ael/medusa-plugin-whatsapp
Built by
Version
0.2.5
Last updated
6 months ago
Monthly downloads
Loading downloads

npm version Medusa v2 notification plugin license

@sam-ael/medusa-plugin-whatsapp

Production-focused WhatsApp notification plugin for Medusa v2 with event mapping, template dispatch, and admin-managed operational controls.

Highlights

  • Event -> template mapping from Medusa Admin
  • WhatsApp Cloud API template sending
  • Delivery logs with redacted sensitive fields
  • Workflow-driven delivery for worker deployments
  • Hardened API responses and stricter payload validation
  • as the primary update endpoint
  • Temporary deprecated compatibility with deprecation headers
  • Secret model hardening: access token is env-only

Install

Medusa Configuration

Environment Variables

Admin API

MethodEndpointDescription
Read non-secret config
Create/update non-secret config
Fetch approved WhatsApp templates
List mappings (paginated)
Create mapping
Update mapping (primary)
Deprecated compatibility endpoint
Delete mapping
List message logs (redacted payloads)
Manual/test message send

Security and Reliability Notes

  • Unified error contract:
  • is not accepted in API payloads and is not persisted in DB
  • Redaction policy applied to sensitive request/response payload fields
  • Event-send workflow uses bounded concurrency and per-item failure isolation
  • Timeout controls and retention cleanup job included
  • Indexes added for high-frequency lookup fields

Quality Gates

Smoke tests are available under .

License

MIT