Project

boxcar_api

0.02
No commit activity in last 3 years
No release in over 3 years
A simple way to send notifications to yourself or your users through Boxcar.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

>= 0.6.1
 Project Readme

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.