By using our HipChat integration, Code Climate will automatically post notifications directly to your HipChat room. Notifications will be posted whenever important events occur during our analysis (e.g., your code or test coverage gets better or worse). Here are some examples of notifications we'll post in HipChat:

  • An area of your codebase increases from a D or F to any other grade. For example, from a D to an A.
  • An area of your codebase decreases to a D or F from any other grade. For example, from a B to an F.
  • New code is added to your codebase and its initial grade is a D or F.
  • Test coverage improves or declines.

Note: For an organization-owned repository, you must be in an organization's Owners group to perform the actions described in this article. Alternatively, if you added the repository in question by clicking Add Open Source Repo, you must have GitHub-rights to administer the repository.

Show Me How

The steps below explain how to setup and test Code Climate's HipChat integration. Note that these steps will require you to move back and forth between Code Climate and HipChat.

  1. In your HipChat Group Admin area, click API from the top navigation.

👍

Make sure you create a token in HipChat's Group Admin area

  • The url should look like:
    https://your_hipchat_account.hipchat.com/admin/api
  1. Create an API token for the Code Climate service. Scroll down to the Create New Token section and select Notification as the Type.
  2. Create a Label for the API token (e.g. Code Climate).
  3. Click Create.
  1. Copy the generated API token to your clipboard.
  2. In a new browser window, navigate to your Code Climate Dashboard.
  3. Mouse over your repository's name and click Settings.
  1. Select the Integrations tab.
  2. Next to HipChat, click Set Up.
  1. Paste the API token into the Auth Token field.
  1. Back in HipChat, click the Rooms tab on the top navigation.
  1. Click the name of the room that you would like Code Climate to post to.
  2. Copy the API ID number.
  1. Back in Code Climate, paste the room ID into the Room field.
  2. Ensure Active is checked and click Save.

Note: If you would like Code Climate to alert all users in the room when a new Code Climate notification is posted, check the Notify option.

  1. To verify the HipChat data is valid, click Test Service (this will post a sample message to your HipChat room). If a green message appears at the top of the screen, all is well. If a red error message is displayed, see Troubleshooting below.

Troubleshooting

If you are seeing a red error message after clicking Test Service:

  • Ensure there are no leading or trailing spaces around the API token or room ID that you provided to Code Climate.
  • Ensure your API token is an API Auth Token and was generated from the API tab on your HipChat Group Admin page. It should not be a Room Notifications Token generated from the Rooms tab.