Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.81 KB

README.md

File metadata and controls

53 lines (33 loc) · 1.81 KB
Raw

aws-sns-hipchat Build Status

A simple AWS SNS HTTP(s) endpoint to send notification to HipChat chatroom or Jenkins Job.

Features

  • Designed to run on Heroku
  • Automatically confirm subscription
  • Send notifications to multiple chatrooms
  • Send notifications to multiple Jenkins Jobs.
  • Heroku-compatible logs for every notification and subscribe confirmation

The HTTP(s) API are http://aws-sns-hipchat.herokuapp.com/sns/hipchat/ROOM_ID and http://aws-sns-hipchat.herokuapp.com/sns/jenkins/JOB_NAME, which could be used to register as endpoints on SNS.

Heroku Deployment

kr/heroku-buildpack-go is used for running this project on Heroku, to create Heorku app with the build pack:

heroku create -b https://github.com/kr/heroku-buildpack-go.git

If you're not familiar with using Go on Heroku, check Getting Started with Go on Heroku for more details.

Configuration

To make this app up and work properly, you need to set an environment variable HIPCHAT_AUTH_TOKEN as your API auth token of HipChat. If you wish to use jenkins, se also JENKINS_TOKEN and JENKINS_URL.

heroku config:add HIPCHAT_AUTH_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
heroku config:add JENKINS_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
heroku config:add JENKINS_URL=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Signatures

Signature of the messages send to jenkins are verified.

Contact

Richard Lee

License

aws-sns-hipchat is available under the MIT license. See the LICENSE file for more info.