BugHerd¶
The BugHerd modules allow you to watch, create, update, list, retrieve, and delete the projects and tasks in your BugHerd account.
Getting Started with BugHerd¶
Prerequisites
- A BugHerd account
In order to use BugHerd with Ibexa Connect, it is necessary to have an BugHerd account. If you do not have one, you can create a BugHerd account at bugherd.com/users/registrations/new.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting BugHerd to Ibexa Connect¶
To connect your BugHerd account to Ibexa Connect you need to obtain the API Key from your BugHerd account and insert it in the Create a connection dialog in the Ibexa Connect module.
-
Log in to your BugHerd account.
-
From the top menu, click Settings and copy the API Key to your clipboard.
-
Go to Ibexa Connect and open the BugHerd module's Create a connection dialog.
-
In the Connection name field, enter a name for the connection.
-
In the API Key field, enter the API key copied in step 2, and click Continue.
The connection has been established.
Project¶
Create a Project¶
Creates a new project.
| Project Name | Enter a name for the project. |
| Project URL | Enter the website URL address |
| Is Active | Select whether the project is active. |
| Is Public | Select whether the Project is accessible to the public. |
Get a Project¶
Retrieves a project specified by ID.
| Project ID | Select the Project ID whose details you want to retrieve. |
Update a Project¶
Updates a project specified by ID.
| Project ID | Select the Project ID whose details you want to update. |
| Project Name | Enter a name for the project. |
| Project URL | Enter the website URL address |
| Is Active | Select whether the project is active. |
| Is Public | Select whether the Project is accessible to the public. |
Delete a Project¶
Deletes a project specified by ID.
| Project ID | Select the Project ID you want to delete. |
Tasks¶
Watch New Task Created¶
Triggers when a new task is created.
Note
You do not have to add the webhooks in the BugHerd as it is automatically done for you once you add and save an instant trigger module to your scenario.
| Webhook Name | Enter a name for the webhook. |
| Project ID | Select the Project ID whose new tasks you want to watch. |
Watch a Task Updated¶
Triggers when a task is updated.
Note
You do not have to add the webhooks in the BugHerd as it is automatically done for you once you add and save an instant trigger module to your scenario.
| Webhook Name | Enter a name for the webhook. |
| Project ID | Select the Project ID whose updated tasks you want to watch. |
Watch a Task Deleted¶
Triggers when a task is deleted.
Note
You do not have to add the webhooks in the BugHerd as it is automatically done for you once you add and save an instant trigger module to your scenario.
| Webhook Name | Enter a name for the webhook. |
| Project ID | Select the Project ID whose deleted tasks you want to watch. |
Watch New Comment Added¶
Triggers when a new comment is added.
Note
You do not have to add the webhooks in the BugHerd as it is automatically done for you once you add and save an instant trigger module to your scenario.
| Webhook Name | Enter a name for the webhook. |
| Project ID | Select the Project ID whose task's comments you want to watch. |
Create a Task¶
Creates a task on a specific project.
| Project ID | Select the Project ID whose task you want to create. |
| Description | Enter the details of the task. |
| External ID | Enter a unique custom task ID. |
| Priority | Select the priority of the task. For example, High. |
| Status | Select the status of the task. For example, In Progress. |
| Requester ID | Select the Requester ID who has requested this task. |
| Assigned To | Select the User ID to whom you want to assign this task. |
| Tag Names | Add the tags for the task. |
Get a Task¶
Gets a task specified by ID.
| Project ID | Select the Project ID whose task details you want to retrieve. |
| Task ID | Select the Task ID whose details you want to retrieve. |
Update a Task¶
Updates a task specified by ID.
| Project ID | Select the Project ID whose task details you want to update. |
| Task ID | Select the Task ID whose details you want to update. |
| Description | Enter the details of the task. |
| External ID | Enter a unique custom task ID. |
Add a Comment to a Task¶
Adds a comment to a specific task.
| Project ID | Select the Project ID to whose task you want to add the comment. |
| Task ID | Select the Task ID to which you want to add the comment. |
| Comment's Text | Enter the comment's text which you want to add. |
| User ID | Select the User ID who is adding the comment. |
Create an Attachment on a Task¶
Creates an attachment to a specific task.
Project ID |
Select the Project ID to whose task you want to add an attachment. |
Task ID |
Select the Task ID to which you want to add the attachment. |
How do you want to create the attachment? |
Select the option using which you want to add the attachment to the task:
|
File Name |
Enter the file name with extension. For example, |
File URL |
Enter the URL address to the file. |
File Data |
Enter (map) the file data. |
Find a Task by External ID¶
Finds a task by the external ID.
| Project ID | Select the Project ID to whose task you want to add an attachment. |
| External ID | Enter a unique External ID of the task you are searching for. |
Get an Attachment from a Task¶
Gets a specific attachment from a task specified by ID.
| Project ID | Select the Project ID to whose task's attachment whose details you want to retrieve. |
| Task ID | Select the Task ID whose attachment details you want to retrieve. |
| Attachment ID | Select the Attachment ID whose details you want to retrieve. |
Delete an Attachment From a Task¶
Deletes a specific attachment from a task specified by ID.
| Project ID | Select the Project ID to whose task's attachments you want to delete. |
| Task ID | Select the Task ID whose attachment you want to delete. |
| Attachment ID | Select the Attachment ID whose details you want to delete. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the BugHerd API Documentation. |
Method
Select the HTTP method you want to use:
GET
to retrieve information for an entry.
POST
to create a new entry.
PUT
to update/replace an existing entry.
PATCH
to make a partial entry update.
DELETE
to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - List Projects¶
The following API call returns all the projects from your BugHerd account:
URL:
/api_v2/projects.json
Method:
GET
Matches of the search can be found in the module's Output under Bundle > Body > projects.
In our example, 2 projects were returned:
