Webhook

Integrate your preferred project tools and issue trackers using a webhook

Webhooks

A webhook enables an application to send real-time data or notifications to other systems. It’s an event-driven mechanism to integrate systems that works like a reverse user-defined API callback over HTTP using the POST method.

Simply put, it's a lightweight way for one system to communicate with and notify another system over HTTP about an event or a change.

For instance, if you want to retrieve data about a bug captured via BetterBugs in your application, your application’s webhook URL entered into BetterBugs can simplify this process. Rather than having your application initiate an API call to fetch data from BetterBugs, the webhook URL (serving as your application's endpoint) enables BetterBugs to perform a POST request automatically.

This request delivers the complete data (as a JSON payload) directly to your application. Your application can then process the payload and utilize the retrieved information as needed.

How it works

Here’s how it works:

1. Setup — Your application provides a webhook URL to BetterBugs. This URL acts as the endpoint where data will be delivered.

2. Event Trigger — When you create a report with BetterBugs and share it with your application, BetterBugs dispatches an HTTP POST request to the set webhook URL.

3. Payload Delivery — The HTTP request contains the event data (payload) in a JSON format, which gets delivered to your application and can then be processed as required.

Example use case

If you have a project management application, you can integrate a webhook to retrieve all the information for the software issue or bug captured using BetterBugs to send it to your application backend servers. Your application can then process the sent data (such as bugId, workspaceId, projectId, description, status, priority, type, sessionUrl, and others), visualize, display, or use it as required on the frontend.

Benefits

Benefits of using BetterBugs webhook:

• Send technical data and developer-friendly details of the bugs to your project tools and issue trackers.

• Save massive time, resources, and manual effort for bug reporting and debugging workflows.

• Cut back on to-and-fro communication for reporting and fixing bugs, and manual copy-pasting of information.

Steps for adding your application webhook

Adding your webhook is super simple. Here are the steps for it:

1

Go to the project integrations tab

Open a BetterBugs project within your workspace, and go to Project Settings > Integrations > Webhook (You can also integrate webhook at the workspace level).

2

Enter the endpoint URL (API endpoint)

Hit the “Connect” button. This opens the “Fill up your webhook details” modal window, and enter the URL endpoint for your application.

3

Verify endpoint

Hit the “Verify” button. Note that the URL endpoint should respond with a 2XX series response code (such as 200, 201, or 204) when the verify request is dispatched.

4

Add custom data (optional)

You can also add custom data as "Title and Value" or key: value pairs to be included in the JSON payload when sent to your application.

5

Confirm

Hit “Confirm” and you’re all set.

Sample JSON payload sent by BetterBugs using a webhook URL

Here’s what the payload looks like being sent via webhook:

{
  "customFields": {},
  "bugId": "bug_1234567890abcdef",
  "projectId": "project_abcdef1234567890",
  "workspaceId": "workspace_1234abcd5678efgh",
  "userId": "user_abcdef1234567890",
  "title": "Sample bug title from webhook",
  "description": "<p><strong>Summary:</strong></p><p>This is a sample description for a bug reported via webhook.</p><p>
</p><p><strong>Steps to reproduce:</strong></p><ol><li>Step one</li><li>Step two</li><li>Step three</li></ol><p>
</p><p><strong>Impact:</strong></p><p>Low</p><p>
</p><p><strong>Errors:</strong></p><ul><li>Sample error message</li></ul>",
  "status": "OPEN",
  "priority": "MEDIUM",
  "type": "screenshot",
  "createdAt": "2025-05-01T06:49:40.877Z",
  "updatedAt": "2025-05-01T06:49:58.928Z",
  "sessionUrl": "https://app.example.com/session/bug_1234567890abcdef"
}