> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Aha!

## What's Supported

### Supported Actions

This connector supports:

* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is supported only for `audits`, `historical_audits`, `ideas/endorsements` and `ideas` currently. For all other objects, a full read of the Aha! instance will be done per scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.aha.io/api`.

### Supported Objects

The Aha! connector supports writing to and reading from the following objects:

* [audits](https://www.aha.io/api/resources/audits/retrieve_record_history) (incremental read)
* [capacity\_scenarios](https://www.aha.io/api/resources/capacity_scenarios/list_capacity_scenarios) (read)
* [screen\_definitions](https://www.aha.io/api/resources/custom_layouts/list_all_custom_layouts) (read)
* [custom\_field\_definitions](https://www.aha.io/api/resources/custom_fields/list_all_custom_fields) (read)
* [epics](https://www.aha.io/api/resources/epics/list_epics) (read)
* [features](https://www.aha.io/api/resources/features/list_features) (read)
* [goals](https://www.aha.io/api/resources/goals/list_goals) (read)
* [historical\_audits](https://www.aha.io/api/resources/historical_audits/read_the_contents_of_the_historical_index) (incremental read, write)
* [idea\_portals](https://www.aha.io/api/resources/idea_portals/list_all_idea_portals_in_an_account) (read)
* [idea\_organizations](https://www.aha.io/api/resources/idea_organizations/list_idea_organizations) (read, write)
* [idea\_users](https://www.aha.io/api/resources/idea_users/list_idea_users_for_an_account) (read, write)
* [ideas](https://www.aha.io/api/resources/ideas/list_ideas) (incremental read)
* [ideas/endorsements](https://www.aha.io/api/resources/idea_votes/list_votes_for_an_account) (incremental read)
* [identity\_providers](https://www.aha.io/api/resources/identity_providers/list_active_identity_providers_that_can_be_used_for_sso) (read)
* [initiatives](https://www.aha.io/api/resources/initiatives/list_initiatives) (read)
* [integrations](https://www.aha.io/api/resources/integrations/list_integrations_for_an_account) (read, write)
* [me/tasks](https://www.aha.io/api/resources/me/list_pending_tasks_assigned_to_the_current_user) (read)
* [me/assigned](https://www.aha.io/api/resources/me/list_records_assigned_to_the_current_user) (read)
* [paid\_seat\_groups](https://www.aha.io/api/resources/paid_seat_groups/list_the_administered_paid_seat_groups) (read)
* [products](https://www.aha.io/api/resources/products/list_products_with_idea_portals_in_the_account) (read, write)
* [release\_phases](https://www.aha.io/api/resources/release_phases/list_release_phases_in_the_account) (read, write)
* [schedules](https://www.aha.io/api/resources/schedules/list_schedules) (read)
* [strategy\_models](https://www.aha.io/api/resources/strategic_models/list_strategic_models) (read)
* [strategy\_positions](https://www.aha.io/api/resources/strategic_positionings/list_strategic_positionings) (read)
* [strategy\_visions](https://www.aha.io/api/resources/strategic_visions/list_strategic_visions) (read)
* [team\_members](https://www.aha.io/api/resources/team_members/list_virtual_team_members) (read write)
* [teams](https://www.aha.io/api/resources/teams/list_teams) (read)
* [tasks](https://www.aha.io/api/resources/to-dos/list_approvals) (read, write)
* [users](https://www.aha.io/api/resources/users/list_users) (read)

## Before You Get Started

To integrate Aha! with Ampersand, you need to [Create an Aha! Account](#create-an-aha-account) and obtain the following credentials from your Aha! App:

* Client ID
* Client Secret

You will then use these credentials to connect your application to Ampersand.

### Create an Aha! Account

You need an **Aha!** account to connect with Ampersand. If you do not have an Aha! account, here's how you can sign up:

* Go to the [Aha! site](https://www.aha.io/) and sign up for a free account.
* Sign up using your preferred account.
* Verify your email and complete the registration process.

### Creating an Aha! App

Once your Aha! account is ready, you need to create an Aha! application. Learn more about creating an Aha! application [here](https://www.aha.io/support/api/authentication).

1. Log in to Your [Aha! Account](https://www.aha.io/).

2. Click the gear icon in the top-right corner and then click **Personal**.

3. On the *Personal* settings page, click **Developer**.

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/bcc83d7-Aha1.gif?s=549a4b629facc1bc07fc84a4ba10e279" alt="Img" width="1440" height="702" data-path="images/provider-guides/bcc83d7-Aha1.gif" />

4. Click the **OAuth applications** tab.

5. Click **Register OAuth application**.

6. On the *Register new OAuth application* form, enter the Oauth application **Name** and the Ampersand **Redirect URI**: `https://api.withampersand.com/callbacks/v1/oauth`

7. Click **Create**.

The OAuth applications tab shows **Client ID** and **Client Secret** keys.

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/bbd5309-Aha2.gif?s=45e22d780d4ddce9382c4fbd35d6fce4" alt="Img" width="1440" height="702" data-path="images/provider-guides/bbd5309-Aha2.gif" />

## Add Aha! App Details in Ampersand

1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).

2. Select the project where you want to add the Aha! App.

   <img src="https://mintcdn.com/ampersand-24eb5c1a/CkzFg-K1u4gYx3ZD/images/provider-guides/dd47b7a-Ampersand.png?fit=max&auto=format&n=CkzFg-K1u4gYx3ZD&q=85&s=d580aa00cc421fe14cfbab79c2e0812f" alt="Ampersand Project Selection" width="2244" height="442" data-path="images/provider-guides/dd47b7a-Ampersand.png" />

3. Navigate to the **Provider Apps** section.

4. Select **Aha!** from the Provider list.

5. Enter the previously obtained **Client ID / Application ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.

<img src="https://mintcdn.com/ampersand-24eb5c1a/i4a56x-Fmj6u7jdE/images/provider-guides/c425479-Aha3.gif?s=d98ec396add475b292c5407c783bb08a" alt="Img" width="590" height="510" data-path="images/provider-guides/c425479-Aha3.gif" />

6. Click **Save Changes**

## Using the connector

To start integrating with Aha!:

* Create a manifest file like the [example](https://github.com/amp-labs/samples/blob/main/aha/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component.
* Start using the connector!
  * If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
  * If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
  * If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.
