{"id":21469979,"url":"https://github.com/sensu-plugins/sensu-plugins-hipchat","last_synced_at":"2025-07-15T06:32:33.948Z","repository":{"id":27047579,"uuid":"30512797","full_name":"sensu-plugins/sensu-plugins-hipchat","owner":"sensu-plugins","description":"Handlers for Hipchat","archived":false,"fork":false,"pushed_at":"2021-04-28T21:40:14.000Z","size":64,"stargazers_count":1,"open_issues_count":9,"forks_count":16,"subscribers_count":11,"default_branch":"master","last_synced_at":"2024-11-10T02:23:46.765Z","etag":null,"topics":["alerting","hipchat","sensu-handler","sensu-plugins"],"latest_commit_sha":null,"homepage":"http://sensu-plugins.io","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sensu-plugins.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-09T01:18:26.000Z","updated_at":"2020-09-27T03:49:59.000Z","dependencies_parsed_at":"2022-08-20T17:10:22.161Z","dependency_job_id":null,"html_url":"https://github.com/sensu-plugins/sensu-plugins-hipchat","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensu-plugins%2Fsensu-plugins-hipchat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensu-plugins%2Fsensu-plugins-hipchat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensu-plugins%2Fsensu-plugins-hipchat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sensu-plugins%2Fsensu-plugins-hipchat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sensu-plugins","download_url":"https://codeload.github.com/sensu-plugins/sensu-plugins-hipchat/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226023718,"owners_count":17561517,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["alerting","hipchat","sensu-handler","sensu-plugins"],"created_at":"2024-11-23T09:20:01.733Z","updated_at":"2024-11-23T09:20:02.339Z","avatar_url":"https://github.com/sensu-plugins.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Sensu-Plugins-hipchat\n\n[ ![Build Status](https://travis-ci.org/sensu-plugins/sensu-plugins-hipchat.svg?branch=master)](https://travis-ci.org/sensu-plugins/sensu-plugins-hipchat)\n[![Gem Version](https://badge.fury.io/rb/sensu-plugins-hipchat.svg)](http://badge.fury.io/rb/sensu-plugins-hipchat)\n[![Code Climate](https://codeclimate.com/github/sensu-plugins/sensu-plugins-hipchat/badges/gpa.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-hipchat)\n[![Test Coverage](https://codeclimate.com/github/sensu-plugins/sensu-plugins-hipchat/badges/coverage.svg)](https://codeclimate.com/github/sensu-plugins/sensu-plugins-hipchat)\n[![Dependency Status](https://gemnasium.com/sensu-plugins/sensu-plugins-hipchat.svg)](https://gemnasium.com/sensu-plugins/sensu-plugins-hipchat)\n\n## Functionality\n\n## Files\n * bin/handler-hipchat.rb\n\n## Usage\n\n```\n{\n  \"hipchat\": {\n    \"apikey\": \"1234abcdefg1234abcdefg\",\n    \"apiversion\": \"v1\",\n    \"room\": \"Ops\",\n    \"from\": \"Sensu\",\n    \"message_template\": \"optional message template erb file path - /some/path/to/template.erb\",\n    \"message_format\": \"html\"\n  }\n}\n```\n## Installation\n\n[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)\n\n## Notes\n\n### message_template example\n\n```\n\u003c%=\n[\n  @event[\"action\"].eql?(\"resolve\") ? \"RESOLVED\" : \"ALERT\",\n  \" - [#{event_name}]\u003cbr\u003e\",\n  \"command: #{@event['check']['command']}\u003cbr\u003e\",\n  \"occurrences: #{@event['occurrences']}\u003cbr\u003e\",\n  @event[\"check\"][\"notification\"] || @event[\"check\"][\"output\"],\n  \"\u003cbr\u003e\",\n  playbook,\n].join\n%\u003e\n```\n\n### How to test?\n\n1. Write a configuration file as explained in the *Usage* section\n1. Set the environment variable `SENSU_CONFIG_FILES` to the location of this file\n1. Pipe a sample check result into the handler itself:\n```\ncat \u003c\u003cEOF | bundle exec bin/handler-hipchat.rb\n{\n  \"client\": {\n    \"name\": \"client\"\n  },\n  \"check\": {\n    \"status\": 1,\n    \"name\": \"name\",\n    \"source\": \"source\",\n    \"output\": \"Hello, warning\",\n    \"hipchat_room\": [\"general\",\"important\"]\n  }\n}\nEOF\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensu-plugins%2Fsensu-plugins-hipchat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsensu-plugins%2Fsensu-plugins-hipchat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsensu-plugins%2Fsensu-plugins-hipchat/lists"}