Ruby Gem for using the Flowdock Push API. See Push API documentation for details.
flowdock gem is tested on Ruby 1.9.3 and JRuby.
- HTTParty
- MultiJson
gem install flowdock
If you're using JRuby, you'll also need to install jruby-openssl gem.
To post content to Chat or Team Inbox, you need to use the target flow's API token. They can be found from tokens page.
require 'rubygems'
require 'flowdock'
# create a new Flow object with target flow's api token and external user name (enough for posting to Chat)
flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__", :external_user_name => "John")
# send message to Chat
flow.push_to_chat(:content => "Hello!", :tags => ["cool", "stuff"])# create a new Flow object with target flow's api token and sender information for Team Inbox posting
flow = Flowdock::Flow.new(:api_token => "__FLOW_TOKEN__",
:source => "myapp", :from => {:name => "John Doe", :address => "[email protected]"})
# send message to Team Inbox
flow.push_to_team_inbox(:subject => "Greetings from Flowdock API Gem!",
:content => "<h2>It works!</h2><p>Now you can start developing your awesome application for Flowdock.</p>",
:tags => ["cool", "stuff"], :link => "http://www.flowdock.com/")require 'rubygems'
require 'flowdock'
# create a new Flow object with the api tokens of the target flows
flow = Flowdock::Flow.new(:api_token => ["__FLOW_TOKEN__", "__ANOTHER_FLOW_TOKEN__"], ... )
# see above examples of posting to Chat or Team Inbox-
Flow methods
push_to_team_inbox- Send message to Team Inbox. See API documentation for details.push_to_chat- Send message to Chat. See API documentation for details.send_message(params)- Deprecated. Please usepush_to_team_inboxinstead.
There are separate gems for deployment notifications:
Copyright (c) 2012 Flowdock Ltd. See LICENSE for further details.