By using our Flowdock integration, Code Climate will automatically post notifications directly to your Flowdock 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 Flowdock:

  • 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 Flowdock integration. Note that these steps will require you to move back and forth between Code Climate and Flowdock.

  1. In Flowdock, click your name in the upper-left hand corner of the screen, and select Account.
  1. Click API tokens from the left navigation menu.
  1. Scroll down to the Flow API tokens section and copy the API token.
  1. In a new browser window, navigate to your Code Climate Dashboard.
  2. Mouse over your repository's name and click Settings.
  1. Select the Integrations tab.
  2. Next to Flowdock, click Set Up.
  1. Paste the API token into the API Token field.

  2. To verify the API token is valid, click Test Service (this will post a test message to your flow). 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 that you provided to Code Climate.
  • Ensure you copied your Flow API token not your Personal API token.