# HighQ Collaborate

> [!NOTE]
> The HighQ connector is not self-service yet. Avallone support sets up the connection with you. This page explains what you need to prepare, and how the connection behaves once it is set up.

The HighQ connector finds the files in the HighQ folders you choose. You can then import each file into Avallone as a document of a company.

## How HighQ access works

HighQ has no system account. Avallone signs in to HighQ as one HighQ user, and every request Avallone makes to HighQ runs as that user. Avallone only sees the sites and folders that user can open.

Use a HighQ account that can open every site and folder you want to import from. If the person behind the account leaves or loses access, the connection stops working until someone connects again. A dedicated HighQ account for Avallone avoids this, because it doesn't depend on one person.

## Ask your HighQ administrator

A HighQ system administrator sets up the HighQ side. Send them this list:

1. **Register an API client for Avallone.** HighQ then issues a **client ID** and a **client secret**.
2. **Add Avallone's redirect URL to the API client.** HighQ sends the user back to this address after they sign in, and refuses the sign-in if the address is not registered:

   ```
   https://app.avallone.io/settings/highq
   ```

3. **Set up the HighQ account Avallone signs in as.** It must be able to open every site and folder you want to import from. A dedicated account is best. See [How HighQ access works](#how-highq-access-works).
4. **Share the client ID, the client secret and the instance URL.** Use a secure channel for the credentials if possible.

## What Avallone needs

| Detail | Description |
|---|---|
| Instance URL | The address you open HighQ at, including the instance name, for example `https://yourfirm.highq.com/yourfirm`. It must be an HTTPS address on `highq.com`. |
| Client ID | The API client's identifier. |
| Client secret | The API client's secret. Avallone stores it securely and never shows it again. |
| HighQ account | The account Avallone signs in as. See [How HighQ access works](#how-highq-access-works). |

## Connect a HighQ account

Connecting sends you to HighQ to sign in with the HighQ account. After the sign-in, HighQ sends you back to Avallone, and the connection is saved. The settings page then shows which HighQ account Avallone signs in as.

If the instance URL or the client ID changes later, the HighQ account has to be connected again. A different instance or API client has its own credentials and its own sign-ins. Changing the instance URL also clears the chosen folders, because sites and folders belong to one instance.

## Choose folders

After connecting, you choose what to import from:

- Choose a site to import from **all its folders**.
- Choose individual folders inside a site.

A chosen folder includes all its subfolders. So you can't choose a subfolder of a folder you have already chosen.

## When HighQ stops accepting the connection

HighQ can stop accepting the connection. For example, the HighQ user leaves, loses access, or revokes Avallone's access. Avallone then shows that a HighQ account needs to be connected again, and names the account that was last connected. Connecting again fixes it.