Skip to content

Commit

Permalink
Improved HipChat notifier documentation. (#111)
Browse files Browse the repository at this point in the history
* Improved HipChat notifier documentation.

* More improvements to HipChat notifier doco

Made the quoting of the API URL backticks so it suppresses autolinking as intended and made it clear the default `base-url` works for rooms hosted on  `hipchat.com`
  • Loading branch information
matthewlowry authored and fusiondog committed May 1, 2016
1 parent 663c13a commit 397dcae
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,22 +216,29 @@ prefix: `consul-alerts/config/notifiers/pagerduty/`
| client-name | The monitoring client name |
| client-url | The monitoring client url |

#### Hipchat
#### HipChat

To enable HipChat builtin notifier, set
`consul-alerts/config/notifiers/hipchat/enabled` to `true`. Hipchat details
needs to be configured.

prefix: `consul-alerts/config/notifiers/hipchat/`

| key | description |
|--------------|-----------------------------------------------------|
| enabled | Enable the Hipchat notifier. [Default: false] |
| from | The name to send notifications as |
| cluster-name | The name of the cluster. [Default: "Consul Alerts"] |
| base-url | HipChat base url |
| room-id | The room to post to (mandatory) |
| auth-token | Authentication token (mandatory) |
| key | description |
|--------------|-----------------------------------------------------------|
| enabled | Enable the HipChat notifier. [Default: false] |
| from | The name to send notifications as (optional) |
| cluster-name | The name of the cluster. [Default: "Consul Alerts"] |
| base-url | HipChat base url [Default: `https://api.hipchat.com/v2/`] |
| room-id | The room to post to (mandatory) |
| auth-token | Authentication token (mandatory) |

The `auth-token` needs to be a room notification token for the `room-id`
being posted to.
See [HipChat API docs](https://developer.atlassian.com/hipchat/guide/hipchat-rest-api).

The default `base-url` works for HipChat-hosted rooms. You only need to
override it if you are running your own server.

#### OpsGenie

Expand Down

0 comments on commit 397dcae

Please sign in to comment.