Remove hipchat (#10692)

* Remove hipchat

* Remove hipchat
This commit is contained in:
Fabian Affolter 2019-10-10 18:32:49 +02:00 committed by Franck Nijhof
parent 3026a2dd7c
commit 82feea28bc
3 changed files with 0 additions and 81 deletions

View File

@ -1,79 +0,0 @@
---
title: "HipChat"
description: "Instructions on how to add HipChat notifications to Home Assistant."
logo: hipchat.png
ha_category:
- Notifications
ha_release: 0.52
---
<div class='note'>
This integration was removed from Home Assistant. Slack [has taken](https://www.atlassian.com/blog/announcements/new-atlassian-slack-partnership) over Hipchat and Stride and will therefore stop these platforms. Hipchat was disconnected on February 15th, 2019. This document is now legacy.
</div>
The `hipchat` platform allows you to send notifications from Home Assistant to [HipChat](https://hipchat.com/).
## Setup
You need to obtain a [HipChat API token](https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-access-tokens#APIaccesstokens-Usergeneratedtokens) to be able to send notifications.
## Configuration
To enable the HipChat notification in your installation, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
notify:
- name: NOTIFIER_NAME
platform: hipchat
token: YOUR_TOKEN
room: 1234567
```
{% configuration %}
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
token:
description: The HipChat API token to use for sending HipChat notifications.
required: true
type: string
room:
description: The default room to post to if no room is explicitly specified when sending the notification.
required: true
type: integer
color:
description: Setting color will override the default color for the notification. Valid options are 'yellow', 'green', 'red', 'purple', 'gray', 'random'.
required: false
default: yellow
type: string
notify:
description: Setting notify will override the default notify (blink application icon, chime, or otherwise call attention) setting for the notification. Valid options are 'true' and 'false'.
required: false
default: false
type: boolean
format:
description: Setting format will override the default message format. Valid options are 'text' and 'html'.
required: false
default: text
type: string
host:
description: Setting the host will override the default HipChat server host.
required: false
type: string
{% endconfiguration %}
### HipChat service data
The following attributes can be placed `data` for extended functionality.
| Service data attribute | Optional | Description |
| ---------------------- | -------- | ----------- |
| `room` | yes | (int) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
| `color` | yes | (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
| `notify` | yes | (bool) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
| `format` | yes | (str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.
To use notifications, please see the [getting started with automation page](/getting-started/automation/).

View File

@ -570,7 +570,6 @@
/components/notify.free_mobile /integrations/free_mobile
/components/notify.gntp /integrations/gntp
/components/notify.hangouts /integrations/hangouts
/components/notify.hipchat /integrations/hipchat
/components/notify.homematic /integrations/homematic
/components/notify.html5 /integrations/html5
/components/notify.huawei_lte /integrations/huawei_lte
@ -1432,7 +1431,6 @@
/components/heos /integrations/heos
/components/hikvision /integrations/hikvision
/components/hikvisioncam /integrations/hikvisioncam
/components/hipchat /integrations/hipchat
/components/history /integrations/history
/components/history_graph /integrations/history_graph
/components/history_stats /integrations/history_stats

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.5 KiB