Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
restful message notifications
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
config
lib
tests
views
.gems
.gitignore
LICENSE
README
config.ru
web.rb

README

Pushr - Restful Notification
============================

A restful web service to create and send notifications.

---

Create a new message pusher
---------------------------

To create a node, you send PUT request under http://pushr.heroku.com/n/<new-node-name>, supplied with adapter (name of adapter) and dest (destination).

**URL:**

http://pushr.heroku.com/n/_node-name_

**HTTP Method:**

PUT

**Parameters:**

*  adapter - Adapter name. Can be one of "email", "tweeter" and "growl"
*  dest    - Destination. Depends on adapter, this could be email or address ... etc.

**Examples:**

    RestClient.put 'http://pushr.heroku.com/n/hello', :adapter => "email", :dest => "sample@gmail.com"

    curl 'http://pushr.heroku.com/n/hello' -X PUT -d adapter=email -d dest="sample@gmail.com"

---

Send a message
--------------

To send message, you POST the message to a node.

**URL:**

http://pushr.heroku.com/n/_node-name_

**HTTP Method:**

POST

**Parameters:**

* title    - Optional. Title of notification.
* message  - Message of notification.

**Examples:**

    RestClient.post 'http://pushr.heroku.com/n/hello', :title => "Hi!", :message => "Hello World"

    curl 'http://pushr.heroku.com/n/hello' -X POST -d title="HI!" -d message="Hello World"

---

Delete a Node
-------------

To send message, you POST the message to a node.

**URL:**

http://pushr.heroku.com/n/_node-name_

**HTTP Method:**

DELETE

**Parameters:**

 (none)

**Examples:**
  
    RestClient.delete 'http://pushr.heroku.com/n/hello'

    curl 'http://pushr.heroku.com/n/hello' -X DELETE -d adapter=email -d dest="siu.ying@gmail.com"
Something went wrong with that request. Please try again.