Pivotal Tracker integration setup guide

  • Last updated on April 27, 2018 at 4:37 AM

Screen_Shot_2012-02-28_at_3.33.16_PM.png

Overview

BugHerd's integration with Pivotal Tracker will allow you to sync BugHerd tasks to Pivotal Tracker as stories of type 'Bug'.

The Pivotal integration can be setup as bi-directional. If you configure the BugHerd Web Hook, then when a BugHerd synced story is modified in Pivotal, it will be updated in BugHerd as well.

How it works

When the integration has been setup fully, here's the information that is synchronised:

  • Bug description -> story name
  • Bug requester -> story requester, if user exists in Pivotal project
  • Bug assignee -> story owner, if user exist in Pivotal project
  • Bug status -> story state, depending on whether they are mapped (details below)
  • Bug tags -> Story labels
  • Bug comments
All of the above data will also be synchronised back to BugHerd, when the Web Hook is correctly configured.

Configuration

To add a Pivotal Tracker integration to your account, select integrations at the top of the BugHerd project management pages. On the Integrations page, find Pivotal Tracker and select "add integration". When asked for your API Key, you can find this on your profile page in Pivotal Tracker, towards the bottom of the page. If there is no token, yet, please click the Create New Token link.
Screen_Shot_2012-02-28_at_3.45.08_PM.png
 
Once BugHerd has verified your token, click save to go to the next page. Here you will be able to configure your status mapping. Note: If you don't want to map the statuses you may leave the fields blank.
Screen_Shot_2012-02-28_at_3.49.58_PM.png

 

We recommend the following status map setup, which would suit most users:

Screen_Shot_2012-06-08_at_11.21.07_AM.png

Now that your Pivotal Tracker integration has been created, you can start connecting BugHerd projects you own to your Pivotal projects. Please create a BugHerd project if you do not own any projects yet. To start connecting projects, click on the projects link on the Pivotal Tracker integration:

Screen_Shot_2012-02-28_at_3.53.16_PM.png

On the projects screen, pick a BugHerd project you own from the dropdown on the left, and a Pivotal project from the one on the right. Then to connect the projects, click add:

Screen_Shot_2012-02-28_at_3.56.09_PM.png

Once you have created the link between the projects, BugHerd will start syncing any changes to tasks to Pivotal. If you also would like to synchronise any changes made to BugHerd created stories back, you need to setup the Web Hook. Click configure next to the Pivotal project. The Web Hook configuration dialog will appear:

Screen_Shot_2012-02-28_at_3.58.45_PM.png

Copy the unique web hook URL provided and paste it into field Web Hook URL on the Pivotal project's integration page.

Screen_Shot_2012-02-28_at_4.01.08_PM.png

Please ensure you select "v3" if offered a choice of API versions.

Once you have clicked Save Web Hook Settings in Pivotal, you can verify that it works using the link on the configuration dialog. If you see a message web hook is active, congratulations, your setup is complete, now if you create or update a task in BugHerd, you will see the change in your Pivotal project!

If you experience any issues, help is only a quick message away, please open a support ticket and we'll get back to you as soon as possible.