Built by

Medusa

Category

Notification

Version

1.1.56

Last updated

Oct 26, 2023, 14:08:37 PM6 months ago

Mailchimp

Manage newsletter subscriptions in your commerce application with Mailchimp.

Features

  • Allow customers to subscribe to your newsletter.
  • Provides custom services and endpoints to give developers flexibility in how to implement newsletter subscription.

Prerequisites


How to Install

1. Run the following command in the directory of the Medusa backend:
npm install medusa-plugin-mailchimp
2. Set the following environment variables in
Copy to clipboard
.env
:
MAILCHIMP_API_KEY=<YOUR_API_KEY>
MAILCHIMP_NEWSLETTER_LIST_ID=<YOUR_NEWSLETTER_LIST_ID>
3. In
Copy to clipboard
medusa-config.js
add the following at the end of the
Copy to clipboard
plugins
array:
const plugins = [
// ...,
{
resolve: `medusa-plugin-mailchimp`,
options: {
api_key: process.env.MAILCHIMP_API_KEY,
newsletter_list_id: process.env.MAILCHIMP_NEWSLETTER_LIST_ID,
},
},
]

Test the Plugin

1. Run the following command in the directory of the Medusa backend to run the backend:
npm run start
2. Use the POST or PUT
Copy to clipboard
/mailchimp/subscribe
endpoint or the
Copy to clipboard
MailchimpService
to subscribe to the newsletter.

Additional Resources

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.