mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-06-01 07:46:49 +00:00
c464056402
* 🔥 Removes octopress.js * 🔥 Removes use of root_url var * 🔥 Removes Octopress generator reference from feed * 🔥 Removes delicious support * 🔥 Removes support for Pinboard * 🔥 Removes support for Disqus * 🔥 Removes support for Google Plus * ↩️ Migrate custom after_footer to default template * ↩️ Migrate custom footer to default template * ↩️ Migrate custom header to default template * 🔥 Removes unused template files * 🚀 Places time to read directly in post template * 🚀 Removes unneeded capture from archive_post.html template * 🔥 🚀 Removes unused, but heaving sorting call in component page * 🚀 Merged javascripts into a single file * 🔥 Removes more uses of root_url * 🚀 Removal of unneeded captures from head * 🔥 🚀 Removal of expensive liquid HTML compressor * 🔥 Removes unneeded templates * 🚀 Replaces kramdown with GitHub's CommonMark 🚀 * 💄 Adds Prism code syntax highlighting * ✨ Adds support for redirect in Netlify * ↩️ 🔥 Let Netlify handle all developer doc redirects * ✏️ Fixes typo in redirects file: Netify -> Netlify * 🔥 Removes unused .themes folder * 🔥 Removes unused aside.html template * 🔥 Removes Disqus config leftover * 🔥 Removes rouge highlighter config * 🔥 Removes Octopress 🎉 * 💄 Adjust code block font size and adds soft wraps * 💄 Adds styling for inline code blocks * 💄 Improve styling of note/warning/info boxes + div support * 🔨 Rewrites all note/warning/info boxes
82 lines
3.3 KiB
Markdown
82 lines
3.3 KiB
Markdown
---
|
|
title: "HipChat"
|
|
description: "Instructions on how to add HipChat notifications to Home Assistant."
|
|
logo: hipchat.png
|
|
ha_category:
|
|
- Notifications
|
|
ha_release: 0.52
|
|
redirect_from:
|
|
- /components/notify.hipchat/
|
|
---
|
|
|
|
<div class='note'>
|
|
This integration will be removed from Home Assistant in the future. Slack has taken over Hipchat and Stride and will therefore stop these platforms. For more information: <a href="https://www.atlassian.com/blog/announcements/new-atlassian-slack-partnership">announcement</a>.
|
|
<br>
|
|
<br>
|
|
Hipchat will be discontinued after February 15th, 2019. This to give customers the opportunity to make a switch.
|
|
</div>
|
|
|
|
The `hipchat` platform allows you to send notifications from Home Assistant to [HipChat](https://hipchat.com/).
|
|
|
|
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.
|
|
|
|
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
|
|
default: "https://api.hipchat.com/"
|
|
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/).
|