Aha
This Integration is part of the AHA Pack.#
Supported versions
Supported Cortex XSOAR versions: 6.5.0 and later.
Use the Aha! integration to list and manage Cortex XSOAR features from Aha. This integration was integrated and tested with API version December 02, 2022 release of Aha.
Configure Aha on Cortex XSOAR#
Navigate to Settings > Integrations > Servers & Services.
Search for Aha.
Click Add instance to create and configure a new integration instance.
Parameter Description Required Server URL True Project Name Check the Aha! project name in the URL. Replace the <PROJECT_NAME> placeholder in the following : example.com.aha.io/products/<PROJECT_NAME>/features. True Api Key API Key to access the service REST API. True Trust any certificate (not secure) False Use system proxy settings False Click Test to validate the URLs, token, and connection.
Commands#
You can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
aha-get-features#
Lists all features from service, unless a specific feature is specified.
Base Command#
aha-get-features
Input#
| Argument Name | Description | Required |
|---|---|---|
| from_date | Show features created after this date. Default is 2020-01-01. | Optional |
| feature_name | The name of a specific feature to retrieve. | Optional |
| fields | A comma-separated list of fields to include in the Aha! service response. Default is name,reference_num,id,created_at. | Optional |
| page | The specific results page to retrieve. Default is 1. | Optional |
| per_page | The maximum number of results per page. Default is 30. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| AHA.Feature.id | UUID | The feature ID. |
| AHA.Feature.name | String | The feature name. |
| AHA.Feature.reference_num | String | The feature reference number. |
| AHA.Feature.workflow_status | String | The feature status description. |
| AHA.Feature.description | String | The feature description. |
| AHA.Feature.created_at | Date | The feature creation date. |
Command example#
!aha-get-features
!aha-get-features feature_name=DEMO-10 fields=workflow_status
!aha-get-features fields=workflow_status page=2 per_page=30
aha-edit-feature#
You can edit the following fields in a feature: Name and Description.
Base Command#
aha-edit-feature
Input#
| Argument Name | Description | Required |
|---|---|---|
| feature_name | The name of the feature to edit. | Required |
| fields | Fields in JSON format to edit in a feature. Possible fields are name and status. Status should match Aha values under workflow_status. Example:" {"name": "name", "status" : "Closed"}. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| AHA.Feature.id | UUID | The feature ID. |
| AHA.Feature.name | String | The feature name. |
| AHA.Feature.reference_num | String | The feature reference number. |
| AHA.Feature.workflow_status | String | The feature status description. |
| AHA.Feature.description | String | The feature description. |
| AHA.Feature.created_at | Date | The feature creation date. |
Command example#
!aha-edit-feature feature_name=DEMO-10 fields=`{"name":"the_new_name", "status":"Closed"}
aha-get-ideas#
Lists all ideas from service, unless a specific idea is specified.
Base Command#
aha-get-ideas
Input#
| Argument Name | Description | Required |
|---|---|---|
| from_date | Show ideas created after this date. Default is 2020-01-01. | Optional |
| idea_name | The name of a specific idea to retrieve. | Optional |
| fields | A comma-separated list of fields to include in the Aha! service response. Default is name,reference_num,id,created_at. | Optional |
| page | The specific results page to retrieve. Default is 1. | Optional |
| per_page | The maximum number of results per page. Default is 30. | Optional |
Context Output#
| Path | Type | Description |
|---|---|---|
| AHA.Idea.id | UUID | The idea ID. |
| AHA.Idea.name | String | The idea name. |
| AHA.Idea.reference_num | String | The idea reference number. |
| AHA.Idea.workflow_status | String | The idea status description. |
| AHA.Idea.description | String | The idea description. |
| AHA.Idea.created_at | Date | The idea creation date. |
Command example#
!aha-get-ideas
!aha-get-ideas idea_name=DEMO-I-2895
!aha-get-ideas idea_name=DEMO-I-2895 fields=workflow_status
aha-edit-idea#
Edit an idea status to Shipped.
Base Command#
aha-edit-idea
Input#
| Argument Name | Description | Required |
|---|---|---|
| idea_name | The name of the idea to edit. | Required |
Context Output#
| Path | Type | Description |
|---|---|---|
| AHA.Idea.id | UUID | The idea ID. |
| AHA.Idea.name | String | The idea name. |
| AHA.Idea.reference_num | String | The idea reference number. |
| AHA.Idea.workflow_status | String | The idea status description. |
| AHA.Idea.description | String | The idea description. |
| AHA.Idea.created_at | Date | The idea creation date. |
Command example#
!aha-edit-idea idea_name=DEMO-I-2895