Bugherd

Bugherd is a visual feedback and bug tracking platform designed for web development teams and agencies, enabling clients and team members to provide clear, actionable feedback directly on websites and web applications through an intuitive visual interface.

Power end-to-end data operations for your Bugherd API with Nexla. Our bi-directional Bugherd connector is purpose-built for Bugherd, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Bugherd or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Bugherd workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating a BugHerd credential, you need to obtain authentication credentials from your BugHerd account. BugHerd supports Basic Authentication using either a username and password combination or a personal API key.

To use BugHerd with Nexla, you need:

• Access to your BugHerd account
• A BugHerd account with appropriate permissions to access the projects and resources you want to work with
• Either your username and password, or a personal API key

Personal API keys can be created in your BugHerd account settings. API keys provide a secure alternative to using passwords and can be revoked independently if needed. For detailed information about BugHerd authentication and API key creation, refer to the BugHerd API documentation.

Authenticate

Credentials required

Field	Required	Secret	Description
Username Or API Key	Yes	No	Your username or personal API Key
Password	Yes	Yes	Your password.

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – BugHerd

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your BugHerd username or personal API key in the Username Or API Key field. You can use either your BugHerd username or a personal API key for authentication.

4. Enter your BugHerd password in the Password field. If you are using a personal API key as the username, enter the API key value in this field as well. If you are using your username, enter your BugHerd account password. The default value is x if not specified.

   Keep your authentication credentials secure and do not share them publicly. The credentials provide access to your BugHerd account and should be treated as sensitive information. Personal API keys are recommended over passwords as they can be revoked independently and provide better security.

5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the BugHerd connector tile, then select the credential that will be used to connect to the BugHerd instance, and click Next; or, create a new BugHerd credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common BugHerd endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

Members

This endpoint retrieves a list of all members in your BugHerd account. Use this endpoint when you need to access member information for team management, access control, or user analysis.

• This endpoint automatically retrieves all members from your BugHerd account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://www.bugherd.com/api_v2/users/members.json. The endpoint URL is automatically constructed based on the BugHerd API base URL.
• The endpoint does not use pagination and returns all members in a single request.
• The endpoint will return all members in your account. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. For detailed information about retrieving members, see the BugHerd API documentation.

Guests

This endpoint retrieves a list of all guests in your BugHerd account. Use this endpoint when you need to access guest information for project access management, collaboration tracking, or user analysis.

• This endpoint automatically retrieves all guests from your BugHerd account. No additional configuration is required beyond selecting this endpoint template.
• The endpoint uses GET requests to https://www.bugherd.com/api_v2/users/guests.json. The endpoint URL is automatically constructed based on the BugHerd API base URL.
• The endpoint does not use pagination and returns all guests in a single request.
• The endpoint will return all guests in your account. The response data is extracted from the root-level object in the API response ($), and Nexla will process the entire response structure.

The endpoint uses a static URL (iteration.type: static.url) and does not require pagination. The response data path is $, which extracts the entire root-level object from the API response. For detailed information about retrieving guests, see the BugHerd API documentation.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

BugHerd data sources can also be manually configured to ingest data from any valid BugHerd API v2 endpoint not covered by the pre-built templates, including sources that use chained API calls or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, path to data, and request headers.

BugHerd API endpoints typically follow the pattern https://www.bugherd.com/api_v2/{endpoint_path}.json and require Basic Authentication, which is handled automatically by your credential configuration.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new BugHerd data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the BugHerd destination, and select the Send to Destination option from the menu. Select the BugHerd connector from the list of available destination connectors, then select the credential that will be used to connect to the BugHerd organization, and click Next; or, create a new BugHerd credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common BugHerd endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

Create project

This endpoint creates a new project in your BugHerd account. The project will initially have no members. Use this endpoint when you need to create new projects from your data sources, such as setting up projects for new clients or initializing project structures.

• The endpoint uses POST requests to https://www.bugherd.com/api_v2/projects.json. The endpoint URL is automatically constructed based on the BugHerd API base URL.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the project data to create. The request body should follow the BugHerd API v2 specification for creating projects, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to create a project. If you need to create multiple projects, you can send multiple records, but each will be processed as a separate request.

The request body must be properly formatted JSON that matches the BugHerd API v2 specification for creating projects. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. The newly created project will initially have no members. For detailed information about creating projects, including required fields, field names, and request formats, see the BugHerd API documentation.

Add member

This endpoint adds a member to a project in your BugHerd account. Use this endpoint when you need to add team members or collaborators to existing projects.

• Enter the project ID in the Project Id field. This is the unique identifier of the project to which you want to add a member. Project IDs can be obtained from your BugHerd account or from project-related API endpoints.

• The endpoint uses POST requests to https://www.bugherd.com/api_v2/projects/{'{project_id}'}/add_member.json where {project_id} is the project ID you provide. The endpoint URL is automatically constructed based on the BugHerd API base URL and the project ID.
• The endpoint sends data from your Nexset as the request body in JSON format. Each record in your Nexset will be sent as a JSON object containing the member data to add. The request body should follow the BugHerd API v2 specification for adding members, including required fields and field names.
• Batch mode is disabled by default for this endpoint. Each record in your Nexset will be sent as a separate API request to add a member to the project.

Project IDs can be obtained from your BugHerd account or from project-related API endpoints. The request body must be properly formatted JSON that matches the BugHerd API v2 specification for adding members. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is automatically included in requests. Batch mode is disabled by default (batch.mode: false), so each record will be sent as a separate request. For detailed information about adding members to projects, including required fields, field names, and request formats, see the BugHerd API documentation.

Manual configuration

BugHerd destinations can also be manually configured to send data to any valid BugHerd API v2 endpoint not covered by the pre-built templates. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, and request body.

BugHerd API endpoints typically follow the pattern https://www.bugherd.com/api_v2/{endpoint_path}.json and require Basic Authentication, which is handled automatically by your credential configuration. The BugHerd API v2 primarily uses POST requests with Content-Type: application/json request bodies. Using manual configuration, you can also configure Nexla to automatically send the response received from the BugHerd API after each call to a new Nexla webhook data source.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured BugHerd endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the BugHerd endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.