HipChat service management

With this servcie, you can integrate Bitbucket with HipChat with a repository.  The service connects a single HipChat room to one or more Bitbucket repositories. Once installed, the service sends a notification to the room each time a commit is made to the repository.  You'd need to do this for each repository; you cannot configure it for multiple repositories.

As an alternative to using this service, you can use the HipChat Bitbucket Connector add-on.  The add-on results in the same behavior as the service.  See Use the HipChat integration in this documentation.

If you are having trouble with the service, see Troubleshoot Bitbucket services.  

Setting Up the service

  1. Login to your Bitbucket account as a user with administrative rights to the repo(s) you would like to link.
  2. Go to the repository's homepage.
  3. Click the  settings icon in the upper right of the page.
    The system displays the repository settings. 
  4. Select Services from the lefthand sidebar.
  5. Select HipChat from the services dropdown list.
  6. Click Add service.
  7. A new section appears for the HipChat service. Enter the following information:

    Field
    Description
    API URL Enter http://api.hipchat.com/v1/rooms/message or similar. 
    Room ID Enter a HipChat room ID. See How to find a Hipchat room ID below.
    Token Enter a HipChat API Token. See How to create a HipChat API token below. Hipchat recommends you use a notification token but you can use an admin token also.
  8. Click Save settings.

Testing your service

If you have CuRL installed, you can test the token by filling in the fields with your values:  

curl -v -X POST "https://api.hipchat.com/v1/rooms/message?format=json&auth_token=YOURTOKEN" -d "room_id=ROOM_ID&from=NAME&message=STRING"

 How to create a HipChat API token

  1. Log into HipChat using an account with Group admin rights.
  2. Select the  Group admin from the application menu.
  3. Choose the API tab.
  4. Set the token Type to Notification.
    Use notification tokens for integrating HipChat with other services. 
  5. Press Create.

 How to find a HipChat room ID

  1. Log into HipChat.
  2. Select the My account from the application menu.
  3. Choose the Rooms tab.
  4. Select the room you want.
  5. Look for the API ID field in the room information.

Was this helpful?

Thanks for your feedback!

12 Archived comments

  1. User avatar

    Anonymous

    Would be nice if there was a way to configure the message template it sends to hipchat. My group would prefer first names rather than bitbucket usernames.

    24 Oct 2012
  2. User avatar

    Anonymous

    Please add restrict to branch. I'd prefer to only notify my team of code pushes when they need to review on master.

    11 Jun 2013
  3. User avatar

    Wilforeal

    Is there a way to detect new Issues and have it display in HipChat?

    02 Aug 2013
  4. User avatar

    Roberto Dominguez

    C'mon guys, you own both products, a little bit more detailed information would be appreciated:

    • How to generate the HipChap token? Go to hip chat > Group Admin > API 
    • What type of token is required, admin or notification? Answer: Notification
    • What is the roomId? the room name or jabber id? Answer: Room name it's ok

     

    17 Sep 2013
    1. User avatar

      manthony

      You have a point Roberto. I'll update this.

      17 Sep 2013
    1. User avatar

      manthony

      Hey Roberto, I've got a question for you.  There is a movement here at Atlassian to "document less." So, the idea is if we think that a topic is an edge case or the interface is easily understood, we don't document it.  I'm not saying that was the choice here on this page. I do think, using the "document less" approach we probably would not have documented this topic to the extent you asked for.  

      As a customer, what do you think about this approach to documentation?

      17 Sep 2013
  5. User avatar

    Kevin Marino

    manthony,

    "document less" is only good if the application UI exposes enough to make the choice seem obvious. For anything beyond the "click this, does that" paradigm documentation is important. API information for many web apps is woefully lacking, a review of Stackoverflow questions and similiar sites should be used to gauge the overall quality of an application's UI to present the task solution. 

    So I would say as a developer who hates to write documentation, get a technical editor (smile) .  They are awesome and it means the developers can build the cool stuff without having to build lots of extra UI aspects to accomodate less documentation. I know the QA team will like that too, nothing like having to test a workflow that goes from 3 steps to 10 steps, just to save a few pages of virtual documentation.

    23 Sep 2013
    1. User avatar

      Mary Anthony [Administrative Account]

      Thanks for the response Kevin.  I like your point about API docs. Often time, along with the docs, the tools that can support a good developer experience aren't there either. So, for example, Google Docs has some great plugins for common IDEs.   I really like some of their docs.

       QA using doc is almost always overlooked. QA can use documentation to test with; Course, depends on how the QA team is testing.

      I also count support costs.  For example, what's the cost to answer a support question versus reading the docs. Or simply having the page in the docs as an XREF. 

      23 Sep 2013
      1. User avatar

        Kevin Marino

        Mary,

        Thanks. Yeah this is probably not the best place to have a discussion about documentation , but well that's how we roll. I certainly can appreciate how hard it can be to maintain documentation, but it can be so important. A good example is actually in the setup of Stash for Windows. What should be a straightforward process seems convoluted and lacking based on the documentation. If you read through Installing Stash on Windows it seems fairly normal until you want to do SSL. The instructions are a mix of Apache, Linux, Windows and Overview in a not very coherent structure. It took me some time to get it to work (Disclosure: I prefer Linux for this , but the Windows server was at hand). I muttered several disparaging remarks about the writer while I tried to decipher the instructions (I've since apologized).

        So that is my rant, I hope Atlassian actually adds to the documentation and yeah linux is easier, and if it makes it easier to say use cygwin so its easier to write documentation cool. Just make sure when it jumps to Windows that there is good explanation - Windows is a lot of GUI and pictures is often worth a lot.

        24 Sep 2013
  6. User avatar

    jryding

    Can you guys list somewhere what the exact features of the Bitbucket + HipChat integration is? I've searched all over your sites and don't see a single mention of what this integration actually does.

    09 Oct 2013
  7. User avatar

    Alexander Schatten

    Is it possible to have a hook for both the Wiki and Sourcecode repo?

     

    (general comment: I also think that the integration between Bitbucket and HipChat could be way better as both are from one vendor...)

    17 Oct 2013
    1. User avatar

      manthony

      Alex, a hook for the wiki is a good idea and you should log an enhancement request for that.

      Improvements to our hook documentation and to our hooks in general are not on the near-term plan for the team. I hear your pain about this particular page.  I would suggest you look at Use the HipChat Connector in this documentation.  The connector does everything the hook does and the documentation was recently written and reviewed.

      17 Oct 2013
Powered by Confluence and Scroll Viewport