README
stormpath-mailchimp
Enrich your Mailchimp lists with Stormpath, instantly!
Purpose
If you use Stormpath to store and manage your user accounts,
stormpath-mailchimp
can be used to easily populate your Mailchimp email
lists magically.
Currently, stormpath-mailchimp
will go through your chosen Stormpath, and
subscribe all new users to your Mailchimp mailing list of choice. We'll
automatically handle adding your user's:
- Given Name (first name)
- Surname (last name)
This is useful because in many cases, you want all new users you get to be
automatically subscribed to your company mailing list. stormpath-mailchimp
makes this integration as painless as possible.
Install
You can install stormpath-mailchimp
through npm by
running:
$ npm install -g stormpath-mailchimp
NOTE: Depending on how you have npm
installed, you might need to run the
above command with sudo
.
Setup
Once you have stormpath-mailchimp
installed, you can configure it by running:
$ stormpath-mailchimp --configure
This will prompt you for your Stormpath and Mailchimp API keys (which are both required).
Don't have a Stormpath or Mailchimp account yet?
Both of these services are free to use!
Usage
Using stormpath-mailchimp
is easy! All you do is tell the program what
Stormpath Directory to grab users from, and what Mailchimp list to sync your
users with.
Here's how to do it:
$ stormpath-mailchimp --directory test --list test
The above command will sync all of your users from the Stormpath Directory
test
into your Mailchimp List, also named test
.
This might take a while, depending on how many user accounts you have.
If you'd like to see the available help options, you can run:
$ stormpath-mailchimp --help
NOTE: For best results, consider running stormpath-mailchimp
on a cron job --
this way, any user accounts you have will be automatically updated with the
latest information possible, and you'll continuously have an up-to-date
directory of users!