Boomerang.io

This add-on is operated by Boomerang.io

The Reminder API. Add reminder functionality to your app in no time.

Boomerang.io

Last Updated: 19 May 2014

The Boomerang.io add-on is currently in beta.

Table of Contents

Boomerang.io is an add-on for providing Reminders as a service. It makes adding reminders to your application super simple, with accurate on-time webhook reminders, realtime monitoring, and reliable delivery with redundant failovers to keep you and your customers' minds at ease that they will never miss a reminder notification.

Installing the add-on

Boomerang.io can be attached to a Heroku application via the CLI:

A list of all plans available can be found here.

$ heroku addons:add boomerang
-----> Adding boomerang to sharp-mountain-4005... done, v18 (free)

Once Boomerang.io has been added a BOOMERANG_URL setting will be available in the app configuration and will contain the RESTful URL used to manage your webhook reminders via Boomerang.io. This can be confirmed using the heroku config:get command.

$ heroku config:get BOOMERANG_URL
http://api.boomerang.io/v1/api_key/:api_key/projects/:project_id/boomerangs/

After installing Boomerang.io the application should be configured to fully integrate with the add-on.

REST API

Here is a simple Ruby example of how to create a boomerang reminder via the REST API.

require 'rest-client'

url = ENV['BOOMERANG_URL']
puts "Chucking new boomerang to #{url}"

# creating a boomerang reminder
# set your payload in the msg parameter, that payload will be posted
# via webhook to the URL parameter after the delay time
boomerang = RestClient.post(url, {
  :url=>"http://yourapp.com/webhook",
  :msg=>"your payload",
  :delay=>30
})

puts "boomerang reference id = #{boomerang['boomerang_id']}"

# can also specify unix timestamp as run_at parameter
boomerang = RestClient.post(url, {
  :url=>"http://yourapp.com/webhook",
  :msg=>"your payload",
  :run_at=>1397848442
})

When the delay time or run_at time is up, Boomerang.io will POST a webhook to the url parameter you specified and will have the following form:

{
    "boomerang_id":"40920d7992283ace",
    "msg":"your payload"
}

For complete documentation visit Boomerang.io.

Dashboard

The dashboard can be accessed via the CLI:

$ heroku addons:open boomerang
Opening boomerang for sharp-mountain-4005…

or by visiting the Heroku apps web interface and selecting the application in question. Select Boomerang.io from the Add-ons menu.

Migrating between plans

Plan migrations are easy and instant. Use the heroku addons:upgrade command to migrate to a new plan.

Use the heroku addons:upgrade command to migrate to a new plan.

$ heroku addons:upgrade boomerang:Ikarus
-----> Upgrading boomerang:Ikarus to sharp-mountain-4005... done, v18 ($49/mo)
       Your plan has been updated to: boomerang:Ikarus

Removing the add-on

Boomerang.io can be removed via the CLI.

This will destroy all associated data and cannot be undone!

$ heroku addons:remove boomerang
-----> Removing boomerang from sharp-mountain-4005... done, v20 (free)

Support

All Boomerang.io support and runtime issues should be submitted via on of the Heroku Support channels. Any non-support related issues or product feedback is welcome at support@boomerang.io.