From 13fdb19cfee3d2afffe7fc2a5a457f8ccd748875 Mon Sep 17 00:00:00 2001 From: BioSehnsucht Date: Wed, 16 Aug 2017 18:26:38 -0500 Subject: [PATCH] Add HipChat notify service. (#3166) * Add HipChat notify service. * Updating HipChat notify documentation based on feedback in home-assistant/home-assistant.github.io#3166 * Updating HipChat notify documentation --- source/_components/notify.hipchat.markdown | 53 +++++++++++++++++++++ source/images/supported_brands/hipchat.png | Bin 0 -> 4042 bytes 2 files changed, 53 insertions(+) create mode 100644 source/_components/notify.hipchat.markdown create mode 100644 source/images/supported_brands/hipchat.png diff --git a/source/_components/notify.hipchat.markdown b/source/_components/notify.hipchat.markdown new file mode 100644 index 00000000000..d36905f38ed --- /dev/null +++ b/source/_components/notify.hipchat.markdown @@ -0,0 +1,53 @@ +--- +layout: page +title: "HipChat" +description: "Instructions how to add HipChat notifications to Home Assistant." +date: 2017-08-10 15:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: hipchat.png +ha_category: Notifications +ha_release: "0.52" +--- + + +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: ABCDEFGHJKLMNOPQRSTUVXYZ + room: 1234567 +``` + +Configuration variables: + +- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`. +- **token** (*Required*): The HipChat API token to use for sending HipChat notifications. +- **room** (*Required*): The default room to post to if no room is explicitly specified when sending the notification. +- **color** (*Optional*): 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'. +- **notify** (*Optional*): 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'. +- **format** (*Optional*): Setting format will override the default message format. Default is 'text'. Valid options are 'text' and 'html'. +- **host** (*Optional*): Setting the host will override the default HipChat server host. Default is 'https://api.hipchat.com/'. + +### {% linkable_title 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/). + diff --git a/source/images/supported_brands/hipchat.png b/source/images/supported_brands/hipchat.png new file mode 100644 index 0000000000000000000000000000000000000000..b6ad5b06a05fc7b7b2936d09db3ed95217d07cb6 GIT binary patch literal 4042 zcmb7Hc{G#{_a8+K>f1aFV~@u+c2csI<#}u|#+H3awpK$5A<`Jnj7nq364??WYh{T< zBYSq@n`LAzE!GJ2^Zxn!>pky1_uS9@^KT^%G$#SyEHhcF4^>Gx>OqCACw5`<*99`z|_jySiEu8#(9~=6?CI zJ!&qgWm03lT6D*v zUZG!C?hdFtX2g&&oT*L(Ml;;CYF=Ymb4-ro?Go9D!bWd4=QQ7|rk38|I56gJguaL# zt+_W1=@8dO^of;o{IG}y^xgCfHt;T3s+NtMZ*I$kW5Eu=&g)V%P4E7U zcx1*yl0N5JWdOt;=uVcw21W~3*_7L8EgKUVU0jmdSZnXOi(GJ$ZF&gwHS;4txw~aR z1y=;8Z+<@qYf9&@=PI;6T3fi&=6wU#nP>o{Sxg@gQy+Pflp(hgV77MNU;UsC)}&q( z4#rR4F<98fQ|_lV-lLJx66yq9R8!by+A?k-Ryrkxr~xCANE z96#42BVf>$RdV$k_ipz}q)j2?V_=gtJ1?zmCU_mG`}2M?xCNZ)YrNh>m6;QSXE@VS zj3s~5cixklK&ET0Sn=a|UnyFfSO39hoi#e8;~eptlWl@vpJG%Ml(hMr4fd{3xK`>` z%j9m)Mx?uS{B3@O9A^Ycb^l$627@+ZtiFEmlZglUUB3~igk2}aXS?Ge1zQ$?K?+CT zb)n%r8ETV=hvZ&J<2YJ@VVaKhiIZbW3wxga9g7I@5V7Q=-%s# z!RKBF3>;jKt*4r#5t&x?%0k$_dbIqJ+#f%kg|T!OGVVVW??!tlX>BTsv^LjYLL4-I zH!_v)s7?d_gF+J=Yf$QMYErSh*LPRu?;NWR#Ku@oI*QogR*H5~v-^4@J-2|L^;B&+ z{`ir&c;Zoo<}fpQ6mpiTXkZx?fK|Rw$*3a$#txS1>tjU(w<7e3e&Jhv>t7QZF1vcw zyG7bMUN1r1_b0)v3MOI=AD_yc$vD3(-J_tQKf_1oFX5f_?k=pG6b0&tfYAhB{G`|~ z`OZiEq-byIK?FZ#s_U}(mE#(mL-rQFZm7!hk}tc51voEr2O zSMsvtkCo|6i4)sr>C8AMYjby>$3B7LBXZy>cKqk))74Dt(T@FK{j#=Sjq*DaTtRaaj>8AvgtrS4ld2EGl>LLJRt3njL!UhvB zS@`j(opk2u_2Ikx`vVwSa~=>G`(C4wVF%SSyS|Q@ff0Vd*ry8g>rl1g1(G@N-7pV1 zxym~b!r!!UA1=SJUA&kC&hZz&|803PUqvZqTr@saC~CKpWDHygOb)7SJ55$mn#P5P z)XmADIXpK}aiVLV{tms0tb=*6ppa@rqmHfY+;xMNk9p_=ouFuEq(0d#An~+V0X%mG ze(;UR-o9R^n_BBmc2a3-brH0m+|z?KRJda_34gzgumdA^ML6`NnI?=n%-fx&8_>_nh>M z*a@_SjI5Nh-ge2eRh4a~2rPLuaaeBrgS+zNUWe>AiqQs+S9UhYh#3sU*6v z1etaB6^|$l(|+5i6?@W(@xi>wX`OX-+pPnLuBFh3iw^lL}x(#aFMA0}KPar(kP;D?n3^i zGS2+;)G&sQ6!XO1XLM2(!vf-PE z0I1B{G#1_^q(Av{3z5j>1!!Wny%0t0-5y^JfjuA~D1CiOK^XiFHgmnxa#*teh@kr> z*nLM6>TKk_M-KxIRCGq4?>(ga1zw-KFL#k&JvFi#o$~;x!?2}R=?&B54%;(mYK-;X z=VG8XPC@{`NfP0#jjC>q;t-)o&4Y;qW7MH zl)~sIZy)J6(&1kj6Dg)*tAPp2;jT~}c_HEM0eV9BzDvSW%zt^|<7ai zX5kQ~uMACyq@lVtc`jO5TuFX(?#0CpR#Ds@M~yq&^`gs{(6S)I9mWy+f-u{4e%2FN zI7@!&4u33BNy@=(IlUtUHJv-iggU$Sn2=f*0CT~qP1b-+kALz~bvrR-b~ITu$p~r$ zBN{<=pGbhiM!t1(ZIh;^w9nyg;<9eK2nC4*O00pwGNhnUrMdG(o_tQb@VcQEw5DLV zrf5hU4&-e!s@E%I2Y&1wQyVL=kvp z24vV+D)s0-5W=q>TUXH&+^=DIZV1_Tyrhxo=~5M-zrF z3u?&4Sc9XnXzEs@i~LP>8LkNJSJqa4l z?_%<8^{A;j09y%}-5-us+b=ENd+Q#W{>$ioKlK3Y`Nd-mZ1w^;%SGf)OM6N#UKnTh zko4-Zkoir)g?5k{)-JKM>8$3ldV@>(wdHW_H^>-``(zNt4!7D+8Lz4;|KvBh&^8%f2IMr8*4Dr>7TMckX@i1{ z6!!;9Pj}5r9-56Kr842y)M!qO5%fh0C_0Nn9?T>75t$wd7PKx3?PFr-u8ewFV2S`( zms-BnlEOO|3Y@tu0BRV260tXT6*nB>3H*6SmBi0!vu=@!-P=KzV9H~N%nKLhdJwaq zNM2nwFXZDbPkEcnO%4#%!+Q?j=r}KaI=R1qN)n?ee#{fG_n&3~g?SU3`KU zRG&wF@=%Z{t+aaX65}N`YGQ78}P9@<+#3@J|vAJDph7a^SWks&>DlgiJ z!5Aw`U6z(lLS+4Y^jf#B=fv?WC2tA9~Km>}RuUkM_rcNY>S zu3piblgM4t&bJRPT=WKJrR=7yrdt!la;_dIGS|EkQRrw({_4ceK#}S=lN_k1J7Hod z!&0PqzwE(eM#dNB<(uVi^#eou+PIr zBMbA7{t+taxtkO(_s`@Ts$4Z@e8aY`y$>b!p?&^s@k%)Es^qPva_G^RU5 z9rd>`v_uz2Si$_3J^2HPE~;0rE!ZEAe)f9MNopCVa6g??{h7Z6>HUi7%(7Y4cUvBX zkMGhk|9&FWJQq~7{kst#ZLl~ae4kf7W#9E9uq*wHd{#k;OwccG-3B87mw(4e2x?M0 z@{pZYqw437WhJc0i4DB&<)jog^2CCN^VuoRGj2w}&ky77o$jh#uN*zA&Xm5i=^?TY z_UX==znM?trA0fB%{Ui7bNJ)u&a7Kz z%wa5x0#3ERxQE~8DM@1yvRS7v8NH-{q#QyHTC>He%5$AB`$_D*^dN~F!tAtYUq~^^ zw4t;<7mdQQMT00JJBo(V2T=HZQ@k`3J_jAm^Z%eAoye|#J1)Xj;%%99R^zJVj?*C& c>g{Yj+eK!t@%tj5?*IJ5W-tLNHS~=6Kf-@M&;S4c literal 0 HcmV?d00001