Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

A gem or plugin for both the user and provider Boxcar API.

branch: master
README.mdown

boxcar_api

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 = BoxcarAPI::Provider.new('your_key', 'your_secret')

Subscribe a Boxcar user to your service:

provider.subscribe "user@example.com"

Then send that user a notification:

provider.notify("user@example.com", "Your product has shipped!")

You can also send a group of users a notification:

users = ["user1@example.com", "user2@example.com"]
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

Copyright (c) 2010 Boxcar. MIT Licensed.

Something went wrong with that request. Please try again.