Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Ideas / Create

  • Article
  • 4 minutes to read

Operation Information

Creates an idea against a product in Aha!.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type oAuth 2.0.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose oAuth 2.0 in the Type pick list;
  • Give the oAuth 2.0 KeySafe key a Title (this is the name / identifier for the oAuth 2.0 account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
Client Id string Application Client Id
Client Secret string Application Client Secret
oAuth Scope string Application oAuth Scope
Authorize URL string Application Authorize URL
Access URL string Application Access UR
Response Type string Application Response Type
Additional Params string Application Additional Params
Additional Access Token Params string Application Additional Access Token Request Params
Grant Type string Application Grant Type
Refresh URL string Application Refresh URL
Refresh Grant Type string Application Refresh Grant Type
Refresh Body string Application Refresh Body
Revoke URL string Token Revoke URL
Token string Authentication Token
Refresh Token string Refresh Token
API Endpoint string Optional API Endpoint

Tip

In order to integrate with Aha!, you will first need to register Hornbill as an authorized application within your Aha! instance.

To do this, visit the Personal Settings page in your Aha! account, then click on the Developer option on the left-hand menu, and then click the OAuth Applications tab. Once the tab had loaded, click the Register OAuth Application button.

This will present you with a form containing 2 inputs:

  • In the first input, give the registered application a name. i.e. Hornbill
  • In the second input, enter the following: https://admin.hornbill.com/oauthcallback.php
  • Click the Create button
  • Once the application has been registered, Aha! will provide you with the information you need to populate the above fields.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked oAuth 2.0 account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Product Key product_id string Key of the product the idea should be created in. Yes None provided
Name of the Idea name string Name Yes None provided
Description description string Description of the idea and it can include HTML formatting. No None provided
Workflow Status workflow_status string Status of the idea and it must be one of the valid status values for the selected product. No None provided
Tags tags string Tags can be automatically assigned to the new idea. If more than one tag is used then tags should be separated by commas. No None provided
Categories categories string Names of the existing categories the idea should be assigned to. If more than one category is used then categories should be separated by commas - note that in a CSV, quotes must be used around fields that contain commas. No None provided
Created By Email created_by string Email address of user that created the idea. The email address does not need to be for a user of Aha! Yes None provided
Assign To Email assigned_to_user string Email address of user that is assigned the idea. No None provided
Feature ID feature string Feature ID of the feature that the idea was promoted to. No None provided
Initiative ID initiative string Initiative ID of the initiative that the idea was promoted to. No None provided
Master Feature ID master_feature string Master feature ID of the master feature that the idea was promoted to. No None provided
Initial Votes initial_votes integer Number of votes to seed the vote count with. No None provided
Visibility visibility string Initial visibility of the idea (‘aha’, ‘employee’, or ‘public’ - ‘aha’ is the default) No None provided
Custom Fields custom_fields array Array of custom fields No None provided

Output Parameters

Display Name ID Type Description
ID id string Idea ID
Reference reference string Idea Reference Key
URL url string Idea URL
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document