Skip to content


Subversion checkout URL

You can clone with
Download ZIP
A gem or plugin for both the user and provider Boxcar API.
Branch: master
Failed to load latest commit information.
examples Who needs puts anyway
lib Allow provider creation via URL.
spec Remove user spec.
Manifest Update manifest.
README.mdown Change readme to point to examples instead of wiki.
Rakefile Merge jtadeulopes
init.rb Add init.rb to allow the API to be used as a plugin.



Release Notes

Version 1.2

Updated to support new API features.

The Boxcar API Gem

boxcar_api is an easy way to add Boxcar notifications to your application.

Getting Started

First, you'll need to create a provider here. We'll give you a provider key and a provider secret. Once you have those, you can get started:

provider ='your_key', 'your_secret')

Subscribe a Boxcar user to your service:

provider.subscribe ""

Then send that user a notification:

provider.notify("", "Your product has shipped!")

You can also send a group of users a notification:

users = ["", ""]
provider.batch_notify(users, "Your account has been upgraded.")

Or reach all of your subscribers with a broadcast:

provider.broadcast "Maintenance has begun. We expect to be back up 15 minutes."

Want to know more? Check out our API docs and the examples for all the details.


Copyright (c) 2010 Boxcar. MIT Licensed.

Something went wrong with that request. Please try again.