Integrating BugHerd

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation.

BugHerd lets Developer Services portal users submit comments and bug reports by making annotations directly on the portal. BugHerd converts these annotations to bug reports. You can then manage these bug reports to categorize them, assign them to developers, and track progress.

BugHerd integration can be used internally by the team creating the portal to collect, track, and resolve issues. Less frequently, you can enable external users of the portal to create BugHerd annotations. You might do that for users for a specific user role, but not for all portal users.

To add support for BugHerd to the portal:

  • Create a BugHerd account at to obtain a BugHerd project key.
  • Enable the Drupal BugHerd module on the developer portal. The BugHerd module ships with the developer portal, but it is disabled by default.
  • Configured the BugHerd module by specifying the project key that you obtained from BugHerd.

The Drupal BugHerd module lets you control which user role has the necessary permission to create a BugHerd annotation, and lets you enable or disable annotations on portal administration pages.

Configure the Drupal BugHerd module

  1. Register for a free BugHerd account at to obtain your BugHerd project key. You can later convert the free account into a paid account. As part of setting up your account, you:
    • Specify the name of your project.
    • Download and install the BugHerd browser extension in your browser.
    • Specify the URL of your portal.
    • Add a test annotation.
    • Invite others.
  2. After registering your account, on the BugHerd site select Settings > General Settings in the menu.
  3. Copy the BugHerd API key value. This is the value that you use as the project key when configuring the BugHerd module.
  4. Log in to the developer portal as a user with admin privileges.
  5. Select Modules in the Drupal administration menu. The list of all installed Drupal modules appears.
  6. Enable the BugHerd Integration module.
  7. Select Save configuration.
    After the save completes, you will see a message at the top of the page prompting you to configure the BugHerd project key.

  8. Select the Configure BugHerd link in the message.
  9. Enter the BugHerd project key, called the API key on the BugHerd site, that you copied in Step 3 and save the configuration.
  10. Select People in the Drupal administration menu.
  11. Select the Permissions link at the top of the page to view the permission setting for every Drupal role.
  12. Scroll down to the BugHerd integration section of the page.

  13. Set the desired permissions for your Drupal roles.
  14. Select Save permissions.

After you enable BugHerd

After you enable BugHerd and download the BugHerd browser extension, the BugHerd sidebar appears in the browser whenever you view a page on the portal.

Use the sidebar to add and manage issues, or log in to BugHerd and manage your project from there.

To add additional users

To add additional users, log in to your project on BugHerd,, and select Team from the BugHerd menu. Use that menu entry to invite new users. The user receives an email from BugHerd with additional instructions.