ByteChef LogoByteChef

Aha!

Aha! is a comprehensive product management software platform that helps teams set strategy, capture ideas, and plan, prioritize, and track work to build products customers love.

Categories: Productivity and Collaboration

Type: aha/v1


Connections

Version: 1

OAuth2 Authorization Code

Properties

NameLabelTypeDescriptionRequired
subdomainSubdomainSTRINGThe subdomain of your Aha! account. For example, if your Aha! URL is https://mycompany.aha.io, then the subdomain is mycompany.true
clientIdClient IdSTRINGtrue
clientSecretClient SecretSTRINGtrue

Connection Setup

Create OAuth Application

  1. Navigate to your Aha! dashboard.
  2. Click on Personal.
  3. Click on Developer.
  4. Click on OAuth applications.
  5. Click on Register OAuth application.
  6. Enter name of your OAuth application.
  7. Enter Redirect URI depending on your instance:
    • https://app.bytechef.io/callback (Cloud)
    • http://localhost:5173/callback (Local dev)
  8. Click Create.
  9. Here you can see your credentials.
  10. Done 🚀.

Actions

Create Feature

Name: createFeature

Creates a new feature.

Properties

NameLabelTypeDescriptionRequired
productIdProduct IDSTRINGID of the product to which the release belongs.false
releaseIdRelease IDSTRING
Depends On productId
Numeric ID or key of the release.true
nameNameSTRINGName of the feature.true

Example JSON Structure

{
  "label" : "Create Feature",
  "name" : "createFeature",
  "parameters" : {
    "productId" : "",
    "releaseId" : "",
    "name" : ""
  },
  "type" : "aha/v1/createFeature"
}

Output

Type: OBJECT

Properties

NameTypeDescription
featureOBJECT
Properties {STRING(id), STRING(name), STRING(reference_num), STRING(release_reference_num), INTEGER(position), INTEGER(score), DATE_TIME(created_at), DATE_TIME(updated_at), STRING(product_id), INTEGER(progress), STRING(progress_source), DATE(status_changed_on), {STRING(id), STRING(name), STRING(email), DATE_TIME(created_at), DATE_TIME(updated_at)}(created_by_user), {STRING(id), STRING(name)}(workflow_kind), {STRING(id), STRING(name), INTEGER(position), BOOLEAN(complete), STRING(color)}(workflow_status)}

Output Example

{
  "feature" : {
    "id" : "",
    "name" : "",
    "reference_num" : "",
    "release_reference_num" : "",
    "position" : 1,
    "score" : 1,
    "created_at" : "2021-01-01T00:00:00",
    "updated_at" : "2021-01-01T00:00:00",
    "product_id" : "",
    "progress" : 1,
    "progress_source" : "",
    "status_changed_on" : "2021-01-01",
    "created_by_user" : {
      "id" : "",
      "name" : "",
      "email" : "",
      "created_at" : "2021-01-01T00:00:00",
      "updated_at" : "2021-01-01T00:00:00"
    },
    "workflow_kind" : {
      "id" : "",
      "name" : ""
    },
    "workflow_status" : {
      "id" : "",
      "name" : "",
      "position" : 1,
      "complete" : false,
      "color" : ""
    }
  }
}

Find product ID and release ID

To find the Product ID, click here.

To find the Release ID, click here.

Create Idea

Name: createIdea

Creates a new idea.

Properties

NameLabelTypeDescriptionRequired
productIdProduct IDSTRINGNumeric ID or key of the product.true
nameNameSTRINGName of the idea.true
descriptionDescriptionSTRINGDescription of the idea.false

Example JSON Structure

{
  "label" : "Create Idea",
  "name" : "createIdea",
  "parameters" : {
    "productId" : "",
    "name" : "",
    "description" : ""
  },
  "type" : "aha/v1/createIdea"
}

Output

Type: OBJECT

Properties

NameTypeDescription
ideaOBJECT
Properties {STRING(id), STRING(name), STRING(reference_number), INTEGER(score), DATE_TIME(created_at), DATE_TIME(updated_at), STRING(product_id), INTEGER(votes), INTEGER(initial_votes), DATE_TIME(status_changed_at), {STRING(id), STRING(name), INTEGER(position), BOOLEAN(complete), STRING(color)}(workflow_status), {STRING(id), STRING(body), DATE_TIME(created_at), DATE_TIME(updated_at)}(description), STRING(visibility), STRING(url), STRING(resource), {STRING(id), STRING(reference_prefix), STRING(name), BOOLEAN(product_line), DATE_TIME(created_at), STRING(workspace_type), STRING(url)}(product), {STRING(id), STRING(name), STRING(email), DATE_TIME(created_at), DATE_TIME(updated_at)}(created_by_user), INTEGER(endorsements_count), INTEGER(comments_count), [{STRING(status_id), STRING(status_name), DATE_TIME(started_at), DATE_TIME(ended_at)}](workflow_status_times), STRING(submitted_idea_portal_record_url)}

Output Example

{
  "idea" : {
    "id" : "",
    "name" : "",
    "reference_number" : "",
    "score" : 1,
    "created_at" : "2021-01-01T00:00:00",
    "updated_at" : "2021-01-01T00:00:00",
    "product_id" : "",
    "votes" : 1,
    "initial_votes" : 1,
    "status_changed_at" : "2021-01-01T00:00:00",
    "workflow_status" : {
      "id" : "",
      "name" : "",
      "position" : 1,
      "complete" : false,
      "color" : ""
    },
    "description" : {
      "id" : "",
      "body" : "",
      "created_at" : "2021-01-01T00:00:00",
      "updated_at" : "2021-01-01T00:00:00"
    },
    "visibility" : "",
    "url" : "",
    "resource" : "",
    "product" : {
      "id" : "",
      "reference_prefix" : "",
      "name" : "",
      "product_line" : false,
      "created_at" : "2021-01-01T00:00:00",
      "workspace_type" : "",
      "url" : ""
    },
    "created_by_user" : {
      "id" : "",
      "name" : "",
      "email" : "",
      "created_at" : "2021-01-01T00:00:00",
      "updated_at" : "2021-01-01T00:00:00"
    },
    "endorsements_count" : 1,
    "comments_count" : 1,
    "workflow_status_times" : [ {
      "status_id" : "",
      "status_name" : "",
      "started_at" : "2021-01-01T00:00:00",
      "ended_at" : "2021-01-01T00:00:00"
    } ],
    "submitted_idea_portal_record_url" : ""
  }
}

Find product ID and release ID

To find the Product ID, click here.

To find the Release ID, click here.

What to do if your action is not listed here?

If this component doesn't have the action you need, you can use Custom Action to create your own. Custom Actions empower you to define HTTP requests tailored to your specific requirements, allowing for greater flexibility in integrating with external services or APIs.

To create a Custom Action, simply specify the desired HTTP method, path, and any necessary parameters. This way, you can extend the functionality of your component beyond the predefined actions, ensuring that you can meet all your integration needs effectively.


Additional Instructions

How to find the Release ID

The Release ID (also known as the Reference Number) can be found in the Aha! UI or via the API.

In the Aha! UI

  • Release Detail View: Open a specific release. The Reference Number (e.g., APP-R-1) is displayed in the header or in the URL.
  • Gantt Views: ReleasesGantt. The Reference Number is shown in its own column.
  • Search: Use the search bar (or press /) and type the release name. The Reference Number (e.g., APP-R-1) will appear in the results.

Via API

  • Use the GET /products/{product_id}/releases endpoint.
  • List releases within a product to retrieve their IDs.

How to find the Product ID

The Product ID is a unique numeric value that can be found in the URL or via the API.

Via API

  • Use the GET /products endpoint to retrieve a list of all products and their numeric IDs.
  • Press / to open the search modal. Recently viewed products will be listed with their IDs.

How is this guide?

Last updated on

On this page