380 lines
16 KiB
HTML
380 lines
16 KiB
HTML
<!doctype html>
|
||
<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
|
||
<!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
|
||
<!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
|
||
<!--[if gt IE 8]><!--> <html> <!--<![endif]-->
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
||
<title>HipChat - Home Assistant</title>
|
||
<meta name="author" content="Home Assistant">
|
||
<meta name="description" content="Instructions how to add HipChat notifications to Home Assistant.">
|
||
<meta name="viewport" content="width=device-width">
|
||
<link rel="canonical" href="https://home-assistant.io/components/notify.hipchat/">
|
||
<meta property="fb:app_id" content="338291289691179">
|
||
<meta property="og:title" content="HipChat">
|
||
<meta property="og:site_name" content="Home Assistant">
|
||
<meta property="og:url" content="https://home-assistant.io/components/notify.hipchat/">
|
||
<meta property="og:type" content="article">
|
||
<meta property="og:description" content="Instructions how to add HipChat notifications to Home Assistant.">
|
||
<meta property="og:image" content="https://home-assistant.io/images/default-social.png">
|
||
<meta name="twitter:card" content="summary_large_image">
|
||
<meta name="twitter:site" content="@home_assistant">
|
||
<meta name="twitter:title" content="HipChat">
|
||
<meta name="twitter:description" content="Instructions how to add HipChat notifications to Home Assistant.">
|
||
<meta name="twitter:image" content="https://home-assistant.io/images/default-social.png">
|
||
<link href="/stylesheets/screen.css" media="screen, projection, print" rel="stylesheet">
|
||
<link href="/atom.xml" rel="alternate" title="Home Assistant" type="application/atom+xml">
|
||
<link rel='shortcut icon' href='/images/favicon.ico' />
|
||
<link rel='icon' type='image/png' href='/images/favicon-192x192.png' sizes='192x192' />
|
||
</head>
|
||
<body >
|
||
<header class='site-header'>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item three-tenths lap-two-sixths palm-one-whole ha-title">
|
||
<a href="/" class="site-title">
|
||
<img width='40' src='/demo/favicon-192x192.png'>
|
||
<span>Home Assistant</span>
|
||
</a>
|
||
</div>
|
||
<div class="grid__item seven-tenths lap-four-sixths palm-one-whole">
|
||
<nav>
|
||
<input type="checkbox" id="toggle">
|
||
<label for="toggle" class="toggle" data-open="Main Menu" data-close="Close Menu"></label>
|
||
<ul class="menu pull-right">
|
||
<li><a href="/getting-started/">Getting started</a></li>
|
||
<li><a href="/components/">Components</a></li>
|
||
<li><a href="/docs/">Docs</a></li>
|
||
<li><a href="/cookbook/">Examples</a></li>
|
||
<li><a href="/developers/">Developers</a></li>
|
||
<li><a href="/blog/">Blog</a></li>
|
||
<li><a href="/help/">Need help?</a></li>
|
||
<li><a href='#' class='show-search'><i class="icon-search"></i></a></li>
|
||
</ul>
|
||
</nav>
|
||
<div class='search-container' style='display: none'>
|
||
<div class='search'>
|
||
<i class="icon-search"></i>
|
||
<input id='search' placeholder='Search the docs…'>
|
||
<a href='#' class='close'><i class="icon-remove-sign"></i></a>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</header>
|
||
<div class="grid-wrapper">
|
||
<div class="grid grid-center">
|
||
<div class="grid__item two-thirds lap-one-whole palm-one-whole">
|
||
<article class="page">
|
||
<header>
|
||
<h1 class="title indent">
|
||
HipChat
|
||
</h1>
|
||
</header>
|
||
<hr class="divider">
|
||
<p>The <code class="highlighter-rouge">hipchat</code> platform allows you to send notifications from Home Assistant to <a href="https://hipchat.com/">HipChat</a>.</p>
|
||
<p>You need to obtain a <a href="https://developer.atlassian.com/hipchat/guide/hipchat-rest-api/api-access-tokens#APIaccesstokens-Usergeneratedtokens">HipChat API token</a> to be able to send notifications.</p>
|
||
<p>To enable the HipChat notification in your installation, add the following to your <code class="highlighter-rouge">configuration.yaml</code> file:</p>
|
||
<div class="language-yaml highlighter-rouge"><pre class="highlight"><code><span class="c1"># Example configuration.yaml entry</span>
|
||
<span class="s">notify</span><span class="pi">:</span>
|
||
<span class="pi">-</span> <span class="s">name</span><span class="pi">:</span> <span class="s">NOTIFIER_NAME</span>
|
||
<span class="s">platform</span><span class="pi">:</span> <span class="s">hipchat</span>
|
||
<span class="s">token</span><span class="pi">:</span> <span class="s">ABCDEFGHJKLMNOPQRSTUVXYZ</span>
|
||
<span class="s">room</span><span class="pi">:</span> <span class="s">1234567</span>
|
||
</code></pre>
|
||
</div>
|
||
<p>Configuration variables:</p>
|
||
<ul>
|
||
<li><strong>name</strong> (<em>Optional</em>): Setting the optional parameter <code class="highlighter-rouge">name</code> allows multiple notifiers to be created. The default value is <code class="highlighter-rouge">notify</code>. The notifier will bind to the service <code class="highlighter-rouge">notify.NOTIFIER_NAME</code>.</li>
|
||
<li><strong>token</strong> (<em>Required</em>): The HipChat API token to use for sending HipChat notifications.</li>
|
||
<li><strong>room</strong> (<em>Required</em>): The default room to post to if no room is explicitly specified when sending the notification.</li>
|
||
<li><strong>color</strong> (<em>Optional</em>): Setting color will override the default color for the notification. By default not setting this will post to HipChat using the default color yellow. Valid options are ‘yellow’, ‘green’, ‘red’, ‘purple’, ‘gray’, ‘random’.</li>
|
||
<li><strong>notify</strong> (<em>Optional</em>): Setting notify will override the default notify (blink application icon, chime, or otherwise call attention) setting for the notification. By default this is ‘false’. Valid options are ‘true’ and ‘false’.</li>
|
||
<li><strong>format</strong> (<em>Optional</em>): Setting format will override the default message format. Default is ‘text’. Valid options are ‘text’ and ‘html’.</li>
|
||
<li><strong>host</strong> (<em>Optional</em>): Setting the host will override the default HipChat server host. Default is ‘https://api.hipchat.com/’.</li>
|
||
</ul>
|
||
<h3><a class="title-link" name="hipchat-service-data" href="#hipchat-service-data"></a> HipChat service data</h3>
|
||
<p>The following attributes can be placed <code class="highlighter-rouge">data</code> for extended functionality.</p>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>Service data attribute</th>
|
||
<th>Optional</th>
|
||
<th>Description</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">room</code></td>
|
||
<td>yes</td>
|
||
<td>(int) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">color</code></td>
|
||
<td>yes</td>
|
||
<td>(str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">notify</code></td>
|
||
<td>yes</td>
|
||
<td>(bool) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.</td>
|
||
</tr>
|
||
<tr>
|
||
<td><code class="highlighter-rouge">format</code></td>
|
||
<td>yes</td>
|
||
<td>(str) Same usage as in configuration.yaml. Overrides any setting set in configuration.yaml.</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<p>To use notifications, please see the <a href="/getting-started/automation/">getting started with automation page</a>.</p>
|
||
</article>
|
||
</div>
|
||
<aside id="sidebar" class="grid__item one-third lap-one-whole palm-one-whole">
|
||
<div class="grid">
|
||
<section class="aside-module grid__item one-whole lap-one-half">
|
||
<div class='edit-github'><a href='https://github.com/home-assistant/home-assistant.github.io/tree/current/source/_components/notify.hipchat.markdown'>Edit this page on GitHub</a></div>
|
||
<div class='brand-logo-container section'>
|
||
<img src='/images/supported_brands/hipchat.png' />
|
||
</div>
|
||
<div class='section'>
|
||
Introduced in release: 0.52
|
||
</div>
|
||
<div class='section'>
|
||
Source:
|
||
<a href='https://github.com/home-assistant/home-assistant/blob/master/homeassistant/components/notify/hipchat.py'>notify/hipchat.py</a>
|
||
</div>
|
||
<div class='section'>
|
||
This is a platform for
|
||
<a href='/components/notify/'>the Notifications component</a>.
|
||
</div>
|
||
<div class='section'>
|
||
<h1 class="title delta">Category Notifications</h1>
|
||
<ul class='divided'>
|
||
<li>
|
||
<a href='/components/notify.apns/'>APNS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.aws_lambda/'>AWS Lambda</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.aws_sns/'>AWS SNS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.aws_sqs/'>AWS SQS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.ciscospark/'>Cisco Spark</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.clicksend/'>ClickSend SMS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.clicksend_tts/'>ClickSend text-to-speech</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.clickatell/'>Clickatell SMS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.command_line/'>Command line Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.discord/'>Discord</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.ecobee/'>Ecobee Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.facebook/'>Facebook Messenger</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.file/'>File</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.free_mobile/'>Free Mobile</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.gntp/'>GNTP (Growl)</a>
|
||
</li>
|
||
<li>
|
||
HipChat
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.instapush/'>Instapush</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.xmpp/'>Jabber (XMPP)</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.joaoapps_join/'>Join Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.knx/'>KNX Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.kodi/'>Kodi</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.webostv/'>LG WebOS TV notifications</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.lametric/'>LaMetric Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.lannouncer/'>Lannouncer</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.llamalab_automate/'>LlamaLab Automate</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.mqtt/'>MQTT Notifications</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/mailgun/'>Mailgun</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.mailgun/'>Mailgun Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.matrix/'>Matrix</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.message_bird/'>MessageBird</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.mysensors/'>MySensors Notify</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.mycroft/'>Mycroft AI</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.nfandroidtv/'>Notifications for Android TV / FireTV</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.group/'>Notify Group</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.nma/'>Notify My Android</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.prowl/'>Prowl</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.html5/'>Push Notifications</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.pushbullet/'>Pushbullet</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.pushetta/'>Pushetta</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.pushover/'>Pushover</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.pushsafer/'>Pushsafer</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.rest/'>REST</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.rocketchat/'>Rocket.Chat</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.smtp/'>SMTP</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.sendgrid/'>SendGrid</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.simplepush/'>Simplepush</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.slack/'>Slack</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.syslog/'>Syslog</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.telegram/'>Telegram</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/telegram_bot.broadcast/'>Telegram broadcast</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/telegram_bot.polling/'>Telegram polling</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/telegram_bot.webhooks/'>Telegram webhooks</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.telstra/'>Telstra</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.twilio_call/'>Twilio Call</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.twilio_sms/'>Twilio SMS</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.twitter/'>Twitter</a>
|
||
</li>
|
||
<li>
|
||
<a href='/components/notify.yessssms/'>Yesss SMS</a>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
</div>
|
||
</aside>
|
||
</div>
|
||
</div>
|
||
<footer>
|
||
<div class="grid-wrapper">
|
||
<div class="grid">
|
||
<div class="grid__item">
|
||
<div class="copyright">
|
||
<a rel="me" href='https://twitter.com/home_assistant'><i class="icon-twitter"></i></a>
|
||
<a rel="me" href='https://facebook.com/homeassistantio'><i class="icon-facebook"></i></a>
|
||
<a rel="me" href='https://plus.google.com/110560654828510104551'><i class="icon-google-plus"></i></a>
|
||
<a rel="me" href='https://github.com/home-assistant/home-assistant'><i class="icon-github"></i></a>
|
||
<div class="credit">
|
||
Contact us at <a href='mailto:hello@home-assistant.io'>hello@home-assistant.io</a> (no support!).<br>
|
||
Website powered by <a href='http://jekyllrb.com/'>Jekyll</a> and the <a href='https://github.com/coogie/oscailte'>Oscalite theme</a>.<br />
|
||
Hosted by <a href='https://pages.github.com/'>GitHub</a> and served by <a href='https://cloudflare.com'>CloudFlare</a>.
|
||
</div>
|
||
<a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-nc-sa/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">home-assistant.io</span> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-nc-sa/4.0/">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License</a>.
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
<script>
|
||
var _gaq=[['_setAccount','UA-57927901-1'],['_trackPageview']];
|
||
(function(d,t){var g=d.createElement(t),s=d.getElementsByTagName(t)[0];
|
||
g.src=('https:'==location.protocol?'//ssl':'//www')+'.google-analytics.com/ga.js';
|
||
s.parentNode.insertBefore(g,s)}(document,'script'));
|
||
</script>
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.css" />
|
||
<script type="text/javascript" src="https://cdn.jsdelivr.net/docsearch.js/2/docsearch.min.js"></script>
|
||
<script type="text/javascript">
|
||
docsearch({
|
||
apiKey: 'ae96d94b201c5444c8a443093edf3efb',
|
||
indexName: 'home-assistant',
|
||
inputSelector: '#search',
|
||
debug: false // Set debug to true if you want to inspect the dropdown
|
||
});
|
||
document.querySelector('.search .close').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'none';
|
||
});
|
||
document.querySelector('.show-search').addEventListener('click', function(ev) {
|
||
ev.preventDefault();
|
||
document.querySelector('.search-container').style.display = 'block';
|
||
document.getElementById('toggle').checked = false;
|
||
document.querySelector('.search-container input').focus();
|
||
});
|
||
</script>
|
||
</body>
|
||
</html>
|