summaryrefslogtreecommitdiff
path: root/docs/hipchat.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'docs/hipchat.markdown')
-rw-r--r--docs/hipchat.markdown31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/hipchat.markdown b/docs/hipchat.markdown
new file mode 100644
index 00000000..45d93eb2
--- /dev/null
+++ b/docs/hipchat.markdown
@@ -0,0 +1,31 @@
+Hipchat integration
+===================
+
+Send notifications to a room
+-----------------------------
+
+Example of notifications:
+
+![Hipchat notification](http://kanboard.net/screenshots/documentation/hipchat-notification.png)
+
+This feature use the room notification token system of Hipchat.
+
+### Hipchat configuration
+
+![Hipchat room token](http://kanboard.net/screenshots/documentation/hipchat-room-token.png)
+
+1. Go to to **My account**
+2. Click on the tab **Rooms** and select the room you want to send the notifications
+3. On the left, choose **Tokens**
+4. Enter a label, by example "Kanboard" and save
+
+### Kanboard configuration
+
+![Hipchat settings](http://kanboard.net/screenshots/documentation/hipchat-settings.png)
+
+1. Go to **Settings > Integrations > Hipchat**
+2. Replace the API url if you use the self-hosted version of Hipchat
+3. Set the room name or the room API ID
+4. Copy and paste the token generated previously
+
+Now, all Kanboard events will be sent to the Hipchat room.