BugHerd API

BugHerd turns client feedback into actionable tasks.

Clients point at what's broken, right on the page, and BugHerd captures the screenshot, browser, OS and selector along with their note.
No more "the button looks wrong" emails.

This module puts the BugHerd sidebar on your site, and lets your own code talk to the BugHerd REST API.

On-page issue reporting

Add your project key at Configuration › System › BugHerd and the sidebar appears. The Access Bugherd permission decides who sees it, so you can give it to a client role without giving it to everyone, and an option keeps it off admin pages so it never covers the toolbar.

REST API client

Added in 2.4.0. With a personal API key, the bugherdapi.client service works with BugHerd data from PHP:

$client = \Drupal::service('bugherdapi.client');
$tasks = $client->getTasks($project_id, ['status' => 'backlog']);
$task = $client->createTask($project_id, ['description' => 'Contact form throws a 500.']);

Covers organization, users, projects, tasks, comments and webhooks, pages through long listings, and throws a typed exception that tells a rejected key from a hit rate limit. Optional - the feedback widget works without it.

The personal API key is secret, unlike the project key, so keep it out of exported config with $config['bugherdapi.settings']['api_key'] in settings.php.

Installation

composer require drupal/bugherdapi

Enable the module, grant Access Bugherd, and add your project key from your BugHerd project's install page. The personal API key is under Settings › General Settings in BugHerd.

Sponsors