Welcome to Bugcrowd's Product Documentation Center

You'll find comprehensive guides and documentation to help you start working with Bugcrowd as quickly as possible.

Hipchat

Staying connected with the Crowdcontrol helps you keep up to date with the latest changes to your program's submissions. Bugcrowd offers an integration with HipChat that enables you to receive notification messages in a particular Hipchat room when the status for a submission changes.

If you set up an integration with Hipchat, the room receives a message when a researcher’s submission is triaged or the status is changed to the "Resolved" or "Unresolved."

When you set up the integration between Hipchat and Crowdcontrol, you can do it on a per program basis. This just means that you can choose the bounty programs you want to integrate with Hipchat.

With the integration enabled, anyone subscribed to the Hipchat room will receive an alert when a submission reaches the "Unresolved" state.

Which version of the API does Bugcrowd use?

Bugcrowd uses Hipchat's V2 API.

1. Generate an API Token in Hipchat

To set up the Hipchat integration, you need to generate an API token that allows Bugcrowd to authenticate to Hipchat's API.

Specific Role Required to Generate an API Token

You must have administrator rights to generate an API token in Hipchat. Learn how to generate an API token in Hipchat.

Go to https://<yourcompany>.hipchat.com/admin/api to generate an API token.

Hipchat API tokens

Hipchat API tokens

Under the API Auth Tokens section, you need to choose the type of token that you want to generate. There are two types: Admin and Notifications. Each one correlates to a different level of access to the APIs.

For the integration with Bugcrowd, choose the "Notification" type and give the token a name that helps you identify its purpose.

Create a token

Create a token

When you are ready, click the "Create" button to generate the API token. Keep the token available. You'll need it for the next step.

2. Set Up the Hipchat Integration in Crowdcontrol

In Crowdcontrol, go to the Program Settings and select the "Integrations" tab.

Program Settings

Program Settings

Find the "Atlassian Hipchat" option from the list of available services and click the "Add Integration" button to display the Hipchat Integration Page.

Hipchat integration

Hipchat integration

Enter the following information for the Hipchat settings:

  • Name: A name for the integration. This can be anything.
  • API token: The API token you generated in Step 1.
  • Room name: The name of the Hipchat room where you want the notifications to appear.
Hipchat integration settings

Hipchat integration settings

After you enter your details, click the "Update Integration" button. The "Connected" status displays under the Hipchat logo.

Successful Connection to Hipchat

Successful Connection to Hipchat

If everything is set up correctly, you will soon see notifications in your Hipchat room whenever the status for a submission is changed to a triaged or accepted state.

Hipchat notification

Hipchat notification