Atlassian HipChat
GitLab provides a way to send HipChat notifications upon a number of events, such as when a user pushes code, creates a branch or tag, adds a comment, and creates a merge request.
Setup
GitLab requires the use of a HipChat v2 API token to work. v1 tokens are not supported at this time. Note the differences between v1 and v2 tokens:
HipChat v1 API (legacy) supports “API Auth Tokens” in the Group API menu. A v1 token is allowed to send messages to any room.
HipChat v2 API has tokens that are can be created using the Integrations tab in the Group or Room admin page. By design, these are lightweight tokens that allow GitLab to send messages only to one room.
Complete these steps in HipChat
- Go to:
https://admin.hipchat.com/admin
- Click on “Group Admin” -> “Integrations”.
- Find “Build Your Own!” and click “Create”.
- Select the desired room, name the integration “GitLab”, and click “Create”.
- In the “Send messages to this room by posting this URL” column, you should see a URL in the format:
https://api.hipchat.com/v2/room/<room>/notification?auth_token=<token>
HipChat is now ready to accept messages from GitLab. Next, set up the HipChat service in GitLab.
Complete these steps in GitLab
- Navigate to the project you want to configure for notifications.
- Navigate to the Integrations page
- Click “HipChat”.
- Ensure that the Active toggle is enabled.
- Insert the
token
field from the URL into theToken
field on the Web page. - Insert the
room
field from the URL into theRoom
field on the Web page. - Save or optionally click “Test Settings”.
Troubleshooting
If you do not see notifications, make sure you are using a HipChat v2 API token, not a v1 token.
Note that the v2 token is tied to a specific room. If you want to be able to
specify arbitrary rooms, you can create an API token for a specific user in
HipChat under “Account settings” and “API access”. Use the XXX
value under
auth_token=XXX
.
Help and feedback
If there's something you don't like about this feature
To propose functionality that GitLab does not yet offer
To further help GitLab in shaping new features
If you didn't find what you were looking for
If you want help with something very specific to your use case, and can use some community support
POST ON GITLAB FORUM
If you have problems setting up or using this feature (depending on your GitLab subscription)
REQUEST SUPPORT
To view all GitLab tiers and features or to upgrade
If you want to try all features available in GitLab.com
If you want to try all features available in GitLab self-managed
If you spot an error or a need for improvement and would like to fix it yourself in a merge request
EDIT THIS PAGE
If you would like to suggest an improvement to this doc