The following is a list of the Triggers/Actions available for you to use with BugHerd.
Triggers:
Actions:
Triggers
Project created
Triggered whenever a new Project is created in BugHerd.
Data:
Field name | Type | Description |
Name | String | Name of the project |
ID | Integer | ID of the project in your BugHerd organization |
Organization ID | Integer | ID of your BugHerd organization |
Feedback URL | String | URL of the project |
Is Public | Boolean | True if "Public Feedback" is enabled in the Project Settings |
Is Active | Boolean | False if the project has been "Disabled" |
Members | Array | Array of JSON object containing members with access to the project. |
Members ID | Array | IDs of members with access to the project |
Members Email | Array | Email addresses of members with access to the project |
Members Display Name | Array | Names of members with access to the project |
Guests | Array | Array of JSON object containing guests with access to the project. |
Guests ID | Array | IDs of guests with access to the project |
Guests Email | Array | Email addresses of guests with access to the project |
Guests Display Name | Array | Names of guests with access to the project |
Task created
Triggered whenever a new Task is created on a project.
Data:
Field name | Type | Description |
BugHerd ID | Int | A unique ID for this task in BugHerd |
Task ID | Int | The ID of the task within this project |
Project ID | Int | The ID of the project |
Description | String | The description of the issue |
Status | String | The status of the task (Backlog, Todo, etc.) |
Severity | String | The severity of the task (critical, important, etc.) |
URL | String | The URL that the task was reported on. |
Share URL | String | A unique public URL to allow viewing/sharing this task without requiring access to BugHerd. |
Task URL | String | The URL to view the task in BugHerd. |
Created At | Date/time | Date/Time that the task was created |
Tags | Array of Strings | Array of tags applied to this task. |
Reported By | JSON Object | JSON object containing details of the user who reported this task. |
Reported By ID | Int | ID of user who reported this task |
Reported By Email | String | Email address of user who reported this task |
Reported by Display Name | String | Name of user who reported this task |
Assigned To | Array | Array of JSON Objects containing details of users assigned to this task |
Assigned To ID | Array | Array of IDs of users assigned to this task |
Assigned To Email | Array | Array of email addresses of users assigned to this task |
Assigned Display Name | Array | Array of the names of users assigned to this task |
OS | String | Operating system of the user who created this task |
Browser | String | Browser of the user who created this task |
Browser Size | String | Browser Viewport size of the user who created this task |
Color Depth | String | Color depth of the monitor used by the user who created this task |
Resolution | String | Resolution of the monitor used by the user who created this task |
Custom Data | JSON Object | Any custom metadata included in the JavaScript embed code you've added to the page (see here for more detail). |
Task created or updated
Triggered when a new task is created, or a task is updated on a project.
Data:
Field name | Type | Description |
BugHerd ID | Int | A unique ID for this task in BugHerd |
Task ID | Int | The ID of the task within this project |
Project ID | Int | The ID of the project |
External ID | String | A field for you to store an ID from another software tool for easier updating of data back into BugHerd |
Description | String | The description of the issue |
Status | String | The status of the task (Backlog, Todo, etc.) |
Severity | String | The severity of the task (critical, important, etc.) |
Attachments | Array | Array of strings containing URLs of files attached to this task. |
URL | String | The URL that the task was reported on. |
Share URL | String | A unique public URL to allow viewing/sharing this task without requiring access to BugHerd. |
Task URL | String | The URL to view the task in BugHerd. |
Created At | Date/time | Date/Time that the task was created |
Due At | Date/time | Due date of the task |
Closed At | Date/time | Date that the task was closed (if status is "closed") |
Deleted At | Date/time | Date that the task was deleted (if applicable) |
Tags | Array of Strings | Array of tags applied to this task. |
Reported By | JSON Object | JSON object containing details of the user who reported this task. |
Reported By ID | Int | ID of user who reported this task |
Reported By Email | String | Email address of user who reported this task |
Reported by Display Name | String | Name of user who reported this task |
Assigned To | Array | Array of JSON Objects containing details of users assigned to this task |
Assigned To ID | Array | Array of IDs of users assigned to this task |
Assigned To Email | Array | Array of email addresses of users assigned to this task |
Assigned Display Name | Array | Array of the names of users assigned to this task |
OS | String | Operating system of the user who created this task |
Browser | String | Browser of the user who created this task |
Browser Size | String | Browser Viewport size of the user who created this task |
Color Depth | String | Color depth of the monitor used by the user who created this task |
Resolution | String | Resolution of the monitor used by the user who created this task |
Custom Data | JSON Object | Any custom meta data included in the JavaScript embed code you've added to the page (see here for more detail). |
Comment created
Triggered when a new comment is added to a Task.
Data:
Field name | Type | Description |
ID | Int | A unique ID for this comment in BugHerd |
Task ID | Int | The ID of the task that this comment is associated with |
Project ID | Int | The ID of the project |
Comment | String | The comment text |
Created at | Date/time | The status of the task (Backlog, Todo, etc.) |
Created By ID | Int | ID of user who created this comment |
Created By Email | String | Email of user who created this comment |
Created By Name | String | Name of user who created this comment
|
Task Description | String | Description of the task that this comment is associated with |
Task URL | String | The URL to view the task in BugHerd. |
Actions
Create a new Task
Create a new Task in a BugHerd Project.
Data:
Field name | Type | Description |
Project ID | Int | (Required) The ID of the project |
Description | String | (Required) Description of the task (2000 character limit) |
Severity | String | (Required) The severity of the task (Critical, Important, etc.) |
Status | String | (Required) The status of the task (Backlog, Todo, etc.) |
Reported By Email | String | Email of user who created this task |
Tags | Array | Array of text tags to add to this task |
Assigned to Email addresses | Array | Array of email addresses of BugHerd users who are assigned to this task. Note: Email addresses must match email of user in BugHerd in order to be correctly assigned. Email addresses that aren't associated with a BugHerd user will be ignored.
|
External ID | String | A field to store a reference or ID to this task in the originating software tool. Use this field as a quick way to be able to look up this task using an ID from your other tools. For example, Trello Card ID, etc. (see Find by External ID below). |
Custom Data | JSON Object | A JSON object that you can use to store any additional with this Task. Note: This data is only available via API, data is not visible in the BugHerd application UI. |
Update a Task
Update a Task in a BugHerd project.
Data:
Field name | Type | Description |
Project ID | Int | (Required) The ID of the project |
Task ID | Int | (Required) The ID of the task |
Description | String | (Required) Description of the task (2000 character limit) |
Severity | String | (Required) The severity of the task (Critical, Important, etc.) |
Status | String | (Required) The status of the task (Backlog, Todo, etc.) |
Reported By Email | String | Email of user who created this task |
Tags | Array | Array of text tags to add to this task |
Due at | Date/Time | Due date of this task |
Assigned to Email addresses | Array | Array of email addresses of BugHerd users who are assigned to this task. Note: Email addresses must match email of user in BugHerd in order to be correctly assigned. Email addresses that aren't associated with a BugHerd user will be ignored. |
External ID | String | A field to store a reference or ID to this task in the originating software tool. Use this field as a quick way to be able to look up this task using an ID from your other tools. For example, Trello Card ID, etc. (see Find by External ID below). |
Custom Data | JSON Object | A JSON object that you can use to store any additional with this Task. Note: This data is only available via API, data is not visible in the BugHerd application UI. |
Add a comment to a Task
Add a comment to a Task in a BugHerd project.
Data:
Field name | Type | Description |
Project ID | Int | (Required) The ID of the project |
Task ID | Int | (Required) The ID of the task |
User email address | String | Email address of the BugHerd user who commented. Note: Email addresses must match email of user in BugHerd in order to be correctly assigned. Email addresses that aren't associated with a BugHerd user will be ignored. |
Comment | String | (Required) The comment text |
Add an attachment to a Task
Add an attachment to a Task in a BugHerd project.
Data:
Field name | Type | Description |
Project ID | Int | (Required) The ID of the project |
Task ID | Int | (Required) The ID of the task |
Filename | String | (Required) the filename of the attachment. This will be appended to the URL field below |
URL | String | (Required) URL location of the attachment |
Create a new Project
Description: Create a new Project in BugHerd.
Data:
Field name | Type | Description |
Name | String | (Required) The name of the project |
Feedback URL | String | (Required) The URL of the project where feedback will be given in BugHerd. |
Allow Public Feedback? | True/False | If True, anonymous users will be able to give feedback on this project. |
URL | String | (Required) URL location of the attachment |
Find a Task by External ID
Description: Find a Task in BugHerd by the External ID that you have set. The External ID can be set via the Update Task action above. This is useful when setting up a 2 way integration between BugHerd and another tool as it allows you to associate the ID of the task in another tool with the related Task in BugHerd (should you ever want to update the Task in BugHerd).
Data:
Field name | Type | Description |
Project ID | String | (Required) The ID of the project |
External ID | String | The external ID field value to search for. |