Aha! Data Source

Aha! is a product development platform for roadmapping, strategic planning, and idea management. Follow the instructions below to create a new data flow that ingests data from an Aha! source in Nexla.

Aha!

Create a New Data Flow

1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

2. Select the Aha! connector tile from the list of available connectors. Then, select the credential that will be used to connect to the Aha! instance, and click Next; or, create a new Aha! credential for use in this flow.

3. In Nexla, Aha! data sources can be created using pre-built endpoint templates, which expedite source setup for common Aha! endpoints. Each template is designed specifically for the corresponding Aha! endpoint, making source configuration easy and efficient.
   • To configure this source using a template, follow the instructions in Configure Using a Template.

   Aha! sources can also be configured manually, allowing you to ingest data from Aha! endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
   • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Aha! endpoints. Each template is designed specifically for the corresponding Aha! endpoint, making data source setup easy and efficient.

Endpoint Settings

• Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

  List products in the account

  This endpoint returns the products in your account. In Aha!, a product is a top-level organizational unit that contains releases, features, and other planning records. Use this endpoint to sync your product catalog into a warehouse or to obtain product IDs for use with other endpoints.

  • Both parameters on this endpoint are optional. Set the Include Teams field to true to include team information in each product record, or leave it as false to omit it.
  • Set the Include Idea Portals field to true to include idea portal information in each product record, or leave it as false to omit it.

  This endpoint is paginated, and Nexla automatically advances through pages to retrieve all available products. Product IDs returned here are used to configure the product-scoped endpoints below, such as List features in a product and List records in a custom table for a product.

  Get a specific product

  This endpoint retrieves the full details of a single product by ID. Use it to enrich an existing dataset of product IDs with the latest product details.

  • Enter the product ID in the Product ID field. This field is required. Product IDs can be obtained from the List products in the account endpoint or from upstream Nexla data flows.

  List features

  This endpoint returns all features across all products and releases in the account. In Aha!, a feature is an individual work item, typically scheduled within a release. Use this endpoint to sync your complete feature backlog into a warehouse or reporting system.

  • No configuration is required for this endpoint beyond selecting it. Nexla automatically paginates through all available features.

  List features in a product

  This endpoint returns all features that belong to a specific product. Use it to sync the feature set for a single product without retrieving the entire account backlog.

  • Enter the product ID in the Product ID field. This field is required. Product IDs can be obtained from the List products in the account endpoint.

  List features in a release

  This endpoint returns all features scheduled within a specific release. In Aha!, a release structures the planned delivery timeline for a set of features. Use this endpoint to track the scope of an individual release.

  • Enter the release ID in the Release ID field. This field is required. Release IDs can be obtained from the Get a specific release or List roll up releases in a product endpoints.

  List features in an epic

  This endpoint returns all features associated with a specific epic. In Aha!, an epic groups related features at a larger scale. Use this endpoint to analyze the features that make up a single epic.

  • Enter the epic ID in the Epic ID field. This field is required. Epic IDs can be obtained from the List epics or Get a specific epic endpoints.

  List features associated with a goal

  This endpoint returns the features linked to a specific goal. In Aha!, a goal defines a strategic objective that aligns work. Use this endpoint to report on the work contributing to a particular goal.

  • Enter the goal ID in the Goal ID field. This field is required. Goal IDs can be obtained from the Get a specific goal endpoint.

  Get a specific feature

  This endpoint retrieves the full details of a single feature by ID. Use it to enrich an existing dataset of feature IDs with the latest feature details.

  • Enter the feature ID in the Feature ID field. This field is required. Feature IDs can be obtained from any of the feature-list endpoints or from upstream Nexla data flows.

  List epics

  This endpoint returns all epics in the account. Use it to sync the complete set of epics into a warehouse or to obtain epic IDs for use with other endpoints.

  • No configuration is required for this endpoint beyond selecting it. Nexla automatically paginates through all available epics.

  Get a specific epic

  This endpoint retrieves the full details of a single epic by ID. Use it to enrich an existing dataset of epic IDs with the latest epic details.

  • Enter the epic ID in the Epic ID field. This field is required. Epic IDs can be obtained from the List epics endpoint or from upstream Nexla data flows.

  Get a specific release

  This endpoint retrieves the full details of a single release by ID. Use it to enrich an existing dataset of release IDs with the latest release details, such as dates and status.

  • Enter the release ID in the Release ID field. This field is required. Release IDs can be obtained from the List roll up releases in a product endpoint or from upstream Nexla data flows.

  List roll up releases in a product

  This endpoint returns the roll-up releases for a specific product. Roll-up releases in Aha! group multiple individual releases to coordinate delivery across products. Use this endpoint to track cross-product delivery timelines.

  • Enter the product ID in the Product ID field. This field is required. Product IDs can be obtained from the List products in the account endpoint.

  Get a specific goal

  This endpoint retrieves the full details of a single goal by ID. Use it to enrich an existing dataset of goal IDs with the latest goal details.

  • Enter the goal ID in the Goal ID field. This field is required. Goal IDs can be obtained from upstream Nexla data flows or from records returned by other Aha! endpoints.

  List all custom fields

  This endpoint returns all custom field definitions configured in the account. Custom fields extend standard Aha! records with organization-specific data. Use this endpoint to obtain field keys and definitions needed to interpret custom field values on other records.

  • No configuration is required for this endpoint beyond selecting it. Nexla automatically paginates through all available custom field definitions.

  List creative briefs in a product

  This endpoint returns the creative briefs associated with a specific product. Use it to sync creative brief data into downstream marketing or reporting systems.

  • Enter the product ID in the Product ID field. This field is required. Product IDs can be obtained from the List products in the account endpoint.

  List records in a custom table for a product

  This endpoint returns the records stored in a custom table (custom object) for a specific product. Custom tables let teams model organization-specific data alongside standard Aha! records. Use this endpoint to ingest that custom data into Nexla.

  • Enter the product ID in the Product ID field. This field is required. Product IDs can be obtained from the List products in the account endpoint.
  • Enter the custom table key in the Custom Table Key field. This field is required and identifies the specific custom table within the product. The key is configured when the custom table is created in Aha!.

  Get a specific custom table record

  This endpoint retrieves the full details of a single custom table record by ID. Use it to enrich an existing dataset of record IDs with the latest custom table data.

  • Enter the record ID in the Record ID field. This field is required. Record IDs can be obtained from the List records in a custom table for a product endpoint or from upstream Nexla data flows.

  List teams

  This endpoint returns the teams in the account. In Aha!, teams organize users for collaborative work. Use this endpoint to sync your team structure into a warehouse or downstream system.

  • The Fields parameter is optional. Enter a comma-separated list of field names to limit the response to only those fields, or leave it blank to return the default set of fields for each team.

  List users

  This endpoint returns the users in the account. Each user represents an account member with role-based permissions. Use this endpoint to sync user records into a warehouse, an identity system, or a reporting tool.

  • No configuration is required for this endpoint beyond selecting it. Nexla automatically paginates through all available users.

Endpoint Testing

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually

Aha! data sources can be manually configured to ingest data from any valid Aha! API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex Aha! sources, such as sources that use chained API calls to fetch data from multiple endpoints or sources that require custom request parameters.

API Method

1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

2. Select the API method that will be used for calls to the Aha! API from the Method pulldown menu. The most common methods are:

   • GET: For retrieving data from the API
   • POST: For sending data to the API or triggering actions
   • PUT: For updating existing data
   • PATCH: For partial updates to existing data
   • DELETE: For removing data

API Endpoint URL

3. Enter the URL of the Aha! API endpoint from which this source will fetch data in the Set API URL field. This should be the complete URL including the protocol (https://) and any required path parameters. Aha! API endpoints follow the format https://<account-domain>.aha.io/api/v1/<resource> — for example, https://mycompany.aha.io/api/v1/features.

Ensure the API endpoint URL uses your account-specific domain and is accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL.

Date/Time Macros (API URL)

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is useful for Aha! endpoints that accept date filters, such as updated_since, to ingest only recently changed records.

Macros are particularly useful for APIs that require date ranges, pagination parameters, or other dynamic values that change between data ingestion runs.

1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

   • {now} – The current datetime
   • {now-1} – The datetime one time unit before the current datetime
   • {now+1} – The datetime one time unit after the current datetime
   • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. This format will be applied to the base datetime value of the macro—i.e., the value of {now} in {now-1}.

3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data. For Aha!, this is useful for driving record-level endpoints — for example, referencing a list of product IDs to fetch features for each one.

Lookup-based macros are useful when you need to create API endpoints that reference specific IDs, values, or parameters from other data sources in your Nexla environment.

1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data

Optional

If only a subset of the data that will be returned by the API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful because Aha! list responses wrap the records in a named array (for example, features or products) alongside pagination metadata.

For example, when a request call is used to fetch a list of items, the API will typically return an array of records, along with metadata, in the response. By entering the path to the relevant data, you can configure Nexla to treat each element of the returned array as a record.

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

• To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

  • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.data.items[*] to access an array of items within a data object).

  • For responses in XML format, enter the XPath that points to the object/array containing relevant data. XPath uses slash notation (e.g., /response/data/item to access item elements within a data element).

  Path to Data Example:

  Aha! list endpoints return a top-level array named for the resource. For the /features endpoint, which returns a top-level array named features, the path to the response would be entered as $.features[*].

Autogenerate Path Suggestions

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

• To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

• Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

  

Metadata

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, Aha! list responses include a pagination object alongside the records array. If you have specified the path to the relevant records but want to retain pagination details such as the total record count, you can specify a path to this metadata to include it with each record in the generated Nexset(s).

Metadata paths are particularly useful for preserving API response context like request IDs, timestamps, or summary statistics that apply to all records in the response.

• To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

  • For responses in JSON format, enter the JSON path to the object or array that contains the metadata, and for responses in XML format, enter the XPath.

Request Headers

Optional

• If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are often required for API versioning, content type specifications, or custom requirements.

  You do not need to include any headers already present in the credentials. The Aha! Authorization header is handled automatically by Nexla based on your credential configuration.

Endpoint Testing

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

• To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

• If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source

1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new Aha! data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.