Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

137 lines (98 sloc) 4.978 kB

Appendix: Mailchimp Integration in Nodejitsu

Nodejitsu features integration with MailChimp. What is MailChimp? In their own words:

MailChimp makes it easy to design exceptional email campaigns, share them on social networks, integrate with web services you already use, manage subscribers and track your results. You'll love mixing and matching MailChimp's templates, features and integrations to suit your needs—think of it as your own personal newsletter publishing platform.

But what about integration? MailChimp integration with Nodejitsu means that you can interact with your MailChimp lists using the same Nodejitsu API that you use to interact with your apps!

Getting Started

In order to set up the MailChimp integration, you have to sign up for MailChimp at their web site:

Once you sign up for MailChimp, they can help you get your bearings so you can get to managing e-mail campaigns quick:

But, in order to integrate with Nodejitsu, what you need is an API key. The easiest way to get an API key right now is to visit

All you have to do to link your MailChimp account with your Nodejitsu account is to copy-and-paste this API key into Nodejitsu's web application interface:

Now you're good to go! Nodejitsu reports that I have one mailing list, and that the two subscribers are Josh's mother and himself.

Interacting with your lists via the Nodejitsu JSON API: A Broad Overview

Like the rest of Nodejitsu's features, addon functionality can be accessed using Nodejitsu's JSON API. For example, here's what happens when you get /addons/:user-id:

$ curl --user 'jesusabdullah:abc123'

{ "_id": "jesusabdullah",
  "username": "jesusabdullah",
  "password-salt": "************",
  "password": "********************************",
  "email": "",
  "addons-mailchimp-apikey": "********************************-us2",
  "_rev": "3-2df3731e8cc48d8e11511096dad140e8",
  "status": "active",
  "inviteCode": "***********",
  "resource": "User" }

In order to interact with the MailChimp add-on in particular, use the /addons/:user-id/signups resource:

$ curl --user 'jesusabdullah:abc123'

{ "lists": 
   { "total": 1,
      [ { "id": "f3b7d6450c",
          "web_id": 646837,
          "name": "Example Mailing List",
          "date_created": "2011-07-26 01:06:42",
          "email_type_option": false,
          "use_awesomebar": true,
          "default_from_name": "Joshua Holbrook",
          "default_from_email": "",
          "default_subject": "Relevant AND Non-Spammy!",
          "default_language": "en",
          "list_rating": 0,
           { "member_count": 2,
             "unsubscribe_count": 0,
             "cleaned_count": 0,
             "member_count_since_send": 3,
             "unsubscribe_count_since_send": 0,
             "cleaned_count_since_send": 0,
             "campaign_count": 0,
             "grouping_count": 0,
             "group_count": 0,
             "merge_var_count": 0,
             "avg_sub_rate": null,
             "avg_unsub_rate": null,
             "target_sub_rate": null,
             "open_rate": null,
             "click_rate": null },
          "modules": [] } ] } }

You can use the list ID to access the particular list information with /addons/:user-id/signups/:list-id/:

curl --user 'jesusabdullah:abc123'

{ "total": 2,
   [ { "email": "holbrook@*********.net",
       "timestamp": "2011-07-26 01:08:11" },
     { "email": "",
       "timestamp": "2011-07-26 01:09:11" } ] }

This confirms that Josh and his Mom are is in the example list.

More API Commands:

  • Retrieve your API key:

    GET /addons/:user-id/signups/apikey/

  • Set your API key:

    PUT /addons/:user-id/signups/apikey/

  • Subscribe to a list:

    POST /addons/:user-id/signups/:list-id/subscribe/

  • Unsubscribe from a list:

    POST /addons/:user-id/signups/:list-id/unsubscribe/

Jump to Line
Something went wrong with that request. Please try again.