Skip to content

sosedoff/slack-notify

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

slack-notify

Send notifications to Slack via webhooks.

Build Status Code Climate Gem Version

Installation

Add this line to your application's Gemfile:

gem "slack-notify"

And then execute:

$ bundle

Or install it yourself as:

$ gem install slack-notify

Usage

Require:

require "slack-notify"

Initialize client:

client = SlackNotify::Client.new(webhook_url: "slack webhook url")

Initialize with options:

client = SlackNotify::Client.new(
  webhook_url: "slack webhook url",
  channel: "#development",
  username: "mybot",
  icon_url: "http://mydomain.com/myimage.png",
  icon_emoji: ":shipit:",
  link_names: 1
)

Initialize via shorthand method:

client = SlackNotify.new(options)

Send test request:

client.test

Send message:

client.notify("Hello There!")
client.notify("Another message", "#channel2")
client.notify("Message", ["#channel1", "#channel2"])

Send direct message:

client.notify("Hello There!", "@username")

You can also test gem via rake console:

rake console

License

Copyright (c) 2013-2015 Dan Sosedoff, [email protected]

MIT License