| Active with remarks |
|---|
| This application needs additional settings. Please follow the documentation below to create your own connectionUnique, active service acces point to a network. There are different types of connections (API key, Oauth…).. |
The Aha! modulesThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) enable you to monitor, create, retrieve, update and delete features or ideas in your Aha! account.
Prerequisites
- An Aha! account
In order to use Aha! with Boost.spaceCentralization and synchronization platform, where you can organize and manage your data. IntegratorPart of the Boost.space system, where you can create your connections and automate your processes., it is necessary to have an Aha! account. If you do not have one, you can create an Aha! account at www.aha.io.
![[Note]](https://docs.boost.space/wp-content/uploads/2022/11/note.png) |
Note |
|---|---|
| The moduleThe module is an application or tool within the Boost.space system. The entire system is built on this concept of modularity. (module - Contacts) dialog fields that are displayed in bold (in the Boost.space Integrator scenarioA specific connection between applications in which data can be transferred. Two types of scenarios: active/inactive., not in this documentation article) are mandatory! |
To connect your Aha! account to Boost.space Integrator you need to obtain the API Key from your Aha! account.
- Log in to your Aha! account.
- Click the cogwheel in the top-right corner (
) and go to Personal > Developer.
- Click the Generate API Key button, enter the name of the API Key, and click Generate API Key.
- Copy the generated API Key.
- Go to Boost.space Integrator and open the Aha! module’s Create a connection dialog.
- Enter the API Key you have copied in step 4 to the respective field and click the Continue button to establish the connection.
The connection has been established. You can proceed with setting up the module.
TriggersEvery scenario has a trigger, an event that starts your scenario. A scenario must have a trigger. There can only be one trigger for each scenario. When you create a new scenario, the first module you choose is your trigger for that scenario. Create a trigger by clicking on the empty module of a newly created scenario or moving the... when a specified activity is performed.
The webhookA webhook is a way for an app to send real-time information to a specific URL in response to certain events or triggers. URL needs to be generated in Boost.space Integrator and then added to Aha!’s integrations settings.
- Add the Watch New Activity module to your Boost.space Integrator scenario.
- Generate and copy the webhook URL.
- Log in to your Aha! account.
- Open Settings > Workspace.
- Click the New Integration button.
- Go to the API Section and click +Activity webhook.
- Enter the webhook URL you have copied in step 2 above to the Hook URL field.
- Select the activities you want to watch or leave the default setting to watch all activities in your workspace.
- Check the Enable checkbox to activate the webhook.
Now, every time the activity is performed, the Watch New Activity module in your Boost.space Integrator scenario is triggered.
|
Note |
|---|---|
| All activity waits five minutes before posting to the Activity webhook. This is to keep the communication concise and to avoid excessive messaging when a userCan use the system on a limited basis based on the rights assigned by the admin. is performing multiple edits at once. |
Triggers when a new feature is created.
The webhook URL needs to be generated in Boost.space Integrator and then added to Aha!’s integrations settings.
- Add the Watch New Feature module to your Boost.space Integrator scenario.
- Generate and copy the webhook URL.
- Log in to your Aha! account.
- Open Settings > Workspace.
- Click the New Integration button.
- Go to the API Section and click +Integration webhook.
- Enter the webhook URL you have copied in step 2 above to the Hook URL field.
- Check the Enable checkbox to activate the webhook.
Now, every time a new feature is created, the Watch New Feature module in your Boost.space Integrator scenario is triggered.
Creates a new feature.
Connection |
Establish a connection to your Aha! account. |
Product ID |
Select the product or map the ID of the product that contains the release you want to create a feature for. |
Release ID |
Select the release or map the ID of the release you want to create a feature for. |
Name |
Enter the name of the new feature. |
Workflow Kind |
Select the type of feature. |
Workflow StatusCreate statuses for each module separately to create an ideal environment for efficient and consistent work. |
Select the status of the feature. |
Description |
Enter the description of the feature. HTML formatting is supported. |
Created By |
Enter the email address of the user that created the feature. |
Assigned To User |
Enter the email address of the user that the feature is assigned to. |
Tags |
Specify the tags you want to assign to the new feature. |
Original Estimate Text |
Enter the original estimated effort in a text format. You can use d, h, min (or ‘p’ for points) to indicate the units to use. |
Original Estimate |
Enter the original estimated effort in minutes. |
Remaining Estimate |
Enter the remaining estimated effort in minutes. |
Start Date |
Enter the date on which the work on the feature will start in the YYYY-MM-DD format. |
Due Date |
Enter the date on which the work on the feature is due to be completed in the YYYY-MM-DD format. |
Release Phase |
Enter the name or ID of the release phase which the feature belongs to. |
Initiative |
Enter the name or ID of the initiative which the feature belongs to. |
Progress Source |
Select the source for calculating progress on the feature. |
Retrieves feature details.
Connection |
Establish a connection to your Aha! account. |
Feature ID |
Enter (map) the ID or select the feature you want to retrieve details about. |
Updates an existing feature.
Connection |
Establish a connection to your Aha! account. |
Feature ID |
Enter (map) the ID or select the feature you want to update. |
Please find the descriptions of the fields in the Create a Feature section above.
Deletes a specified feature.
Connection |
Establish a connection to your Aha! account. |
Feature ID |
Enter (map) the ID or select the feature you want to delete. |
Adds a new idea.
Connection |
Establish a connection to your Aha! account. |
Product ID |
Select the product or map the ID of the product you want to create an idea for. |
Idea Category (optional) |
Select one of the existing categories the idea should be assigned to. |
Name |
Enter the name of the new feature. |
Created By |
Enter the email address of the person that created the idea. |
Description |
Enter the description of the idea. HTML formatting is supported. |
Workflow Status |
Select the status of the idea. It must be one of the valid status values for the selected product. |
Tags |
Specify the tags you want to assign to the new idea. |
Assigned To User |
Enter the email address of the user that the idea is assigned to. |
Feature |
Enter the ID of the feature that the idea was promoted to. |
Initiatives |
Enter the initiative ID of the initiative that the idea was promoted to. |
Initial Votes |
Enter the number of votes to seed the vote count with when importing from other systems. |
Visibility |
Select the initial visibility of the idea. Default is Aha!. |
Retrieves idea details.
Connection |
Establish a connection to your Aha! account. |
Idea ID |
Enter (map) the ID or select the idea you want to retrieve details about. |
Updates an existing idea.
Connection |
Establish a connection to your Aha! account. |
Idea ID |
Enter (map) the ID or select the idea you want to update. |
Please find the descriptions of the fields in the Create an Idea section above.
Deletes a specified idea.
Connection |
Establish a connection to your Aha! account. |
Idea ID |
Enter (map) the ID or select the idea you want to delete. |
Allows you to perform a custom API call.
Connection |
Establish a connection to your Aha! account. | |||
URL |
Enter a path relative to <subdomain>.aha.io/api/.
For example:
|
|||
Method |
Select the HTTP method you want to use:
to retrieve information for an entry.
to create a new entry.
to update/replace an existing entry.
to make a partial entry update.
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. |
The following API call returns all features in your Aha! account:
URL:
/v1/features/
Method:
GET
The result can be found in the module’s Output under BundleA bundle is a chunk of data and the basic unit for use with modules. A bundle consists of items, similar to how a bag may contain separate, individual items. >Body > dashboards.
In our example, 30 features were returned:
