Skip to main content

Bugherd Destination

Nexla's bi-directional connectors allow data to flow both to and from any location, making it simple to create a sync or streaming data flow that sends data to a BugHerd location.
bugherd_api.png

Bugherd

Create a BugHerd Destination​

  1. Click the + icon on the Nexset that will be sent to the BugHerd destination, and select the Send to Destination option from the menu.

  2. 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.

  3. In Nexla, BugHerd destinations can be created using pre-built endpoint templates, which expedite destination setup for common BugHerd endpoints. Each template is designed specifically for the corresponding BugHerd endpoint, making destination configuration easy and efficient.
    • To configure this destination using a template, follow the instructions in Configure Using a Template.

    BugHerd destinations can also be configured manually, allowing you to send data to BugHerd endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this destination manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common BugHerd endpoints. Each template is designed specifically for the corresponding BugHerd endpoint, making destination setup easy and efficient.

  • To configure this destination using a template, 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.

Configure Manually​

BugHerd destinations can be manually configured to send data to any valid BugHerd API v2 endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

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.

API Method​

  1. To manually configure this destination, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the BugHerd API from the Method pulldown menu. The BugHerd API v2 primarily uses POST requests for data writing operations. The most common methods are:

    • POST: For creating new resources (e.g., creating projects, adding members)
    • PUT: For updating existing data
    • PATCH: For partial updates to existing data
    • DELETE: For removing data

Data Format​

  1. Select the format in which the Nexset data will be sent to the BugHerd API from the Content Format pulldown menu. Nexla will automatically convert the data to the selected format for each API call. The BugHerd API v2 typically uses JSON format for request bodies.

API Endpoint URL​

  1. Enter the URL of the BugHerd API endpoint to which you want to send the Nexset data in the URL field. This should be the complete URL including the protocol (https://) and any required path parameters. BugHerd API endpoints typically follow the pattern https://www.bugherd.com/api_v2/{'{endpoint_path}'}.json.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The endpoint requires Basic Authentication, which is handled automatically by your credential configuration. For detailed information about BugHerd API endpoints and available APIs, see the BugHerd API documentation.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this destination, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom authentication requirements.

    You do not need to include any headers already present in the credentials. Common headers like Authorization (Basic Auth), Content-Type, and Accept are typically handled automatically by Nexla based on your credential configuration. The BugHerd API v2 requires Basic Authentication, which is handled automatically by your credential configuration. The Content-Type: application/json header is typically set automatically for JSON request bodies.

Request Body​

Optional

  • If the API endpoint requires a specific request body format, configure how Nexla should format the request body from your Nexset data. The request body can be sent as JSON, XML, or form data, depending on the API endpoint requirements.

    • For JSON format, select JSON from the Request Body Format dropdown, and the Nexset data will be sent as a JSON object in the request body. BugHerd API v2 endpoints typically use JSON format for request bodies.

    • For XML format, select XML from the Request Body Format dropdown, and the Nexset data will be converted to XML format in the request body.

    • For Form data format, select Form Data from the Request Body Format dropdown, and the Nexset data will be sent as form-encoded data in the request body.

Save the Destination​

  1. Once all configuration steps have been completed, click the Save button to save your destination configuration.

  2. The destination will now be available in your data flow and will begin sending data to the BugHerd endpoint according to the configured settings.