Include documentation in the application
This commit is contained in:
38
doc/hipchat.markdown
Normal file
38
doc/hipchat.markdown
Normal file
@@ -0,0 +1,38 @@
|
||||
Hipchat integration
|
||||
===================
|
||||
|
||||
You can send notifications to Hipchat for all projects or only for specific projects.
|
||||
|
||||
- To send notifications for all projects, go to **Settings > Integrations > Hipchat**
|
||||
- To send notifications for only some projects, go to **Project settings > Integrations > Hipchat**
|
||||
|
||||
Each project can send notifications to a separate room.
|
||||
|
||||
Send notifications to a room
|
||||
-----------------------------
|
||||
|
||||
Example of notifications:
|
||||
|
||||

|
||||
|
||||
This feature use the room notification token system of Hipchat.
|
||||
|
||||
### Hipchat configuration
|
||||
|
||||

|
||||
|
||||
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
|
||||
|
||||

|
||||
|
||||
1. Go to **Settings > Integrations > Hipchat** or **Project 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, Kanboard events will be sent to the Hipchat room.
|
||||
Reference in New Issue
Block a user