2020-10-24 23:57:45 +05:30
---
stage: Create
group: Ecosystem
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-04-01 16:36:13 +05:30
# Atlassian HipChat (Deprecated) **(FREE)**
As of [GitLab
13.11](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/57434), the
HipChat integration will not send any notifications to HipChat. This
integration is also deprecated.
2017-08-17 22:00:37 +05:30
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
2021-02-22 17:27:13 +05:30
in the Group or Room administration page. By design, these are lightweight tokens that
2017-08-17 22:00:37 +05:30
allow GitLab to send messages only to *one* room.
### Complete these steps in HipChat
2019-12-21 20:55:43 +05:30
1. Go to: `https://admin.hipchat.com/admin`
2017-08-17 22:00:37 +05:30
1. Click on "Group Admin" -> "Integrations".
1. Find "Build Your Own!" and click "Create".
1. Select the desired room, name the integration "GitLab", and click "Create".
1. In the "Send messages to this room by posting this URL" column, you should
2019-09-30 21:07:59 +05:30
see a URL in the format:
2017-08-17 22:00:37 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2017-08-17 22:00:37 +05:30
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
1. Navigate to the project you want to configure for notifications.
2020-04-22 19:07:51 +05:30
1. Navigate to the [Integrations page ](overview.md#accessing-integrations )
2017-08-17 22:00:37 +05:30
1. Click "HipChat".
2020-04-22 19:07:51 +05:30
1. Ensure that the **Active** toggle is enabled.
2017-08-17 22:00:37 +05:30
1. Insert the `token` field from the URL into the `Token` field on the Web page.
1. Insert the `room` field from the URL into the `Room` field on the Web page.
1. 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` .
