> For the complete documentation index, see [llms.txt](https://docs.balkan.id/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/fivetran-integration-setup.md).

# Fivetran Integration Setup

### Getting Started

Use this guide to connect Fivetran to your BalkanID tenant. You will need credentials from Fivetran and access to the Integrations section in BalkanID.

#### Requirements:

Before you begin, collect the following values from Fivetran:

* **API Key**
* **API Secret**

A Fivetran API key inherits the permissions of the user who creates it, so generate it from an account with an account-level role that can read users, roles, teams and destinations, such as **Account Administrator**. The Fivetran REST API is available on the Standard, Enterprise and Business Critical plans.

### Configure Fivetran within your BalkanID tenant

1. To find the **API Key** and **API Secret**, sign in to your Fivetran dashboard.
2. Click your username, then click **API Key**.
3. Click **Generate API key**. If a key already exists, click **Generate new API key** instead.
4. Copy the key and the secret straight away. Fivetran hides both once you close or navigate away from the page, and you will have to generate a new pair if you lose them.
5. In BalkanID, go to *Integrations* and click **Add integration**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FVwJJi0n0eZXy1MN27DvK%2Ffivetran-add-integration.png?alt=media" alt="The BalkanID Integrations page with the Add integration button in the top right"><figcaption><p>Integrations</p></figcaption></figure></div>

6. Search for Fivetran, select it, and click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FrnR2fli246ZJbMB9BXaj%2Ffivetran-connect-application.png?alt=media" alt="The Connect a new application step with Fivetran selected"><figcaption><p>Connect a new application</p></figcaption></figure></div>

7. Under **Select Extraction Type**, keep **Direct Configuration** selected and paste your API Key and API Secret into the corresponding fields, then click **Next**.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FmUmIDdyleSNyqxUheHjJ%2Ffivetran-direct-configuration.png?alt=media" alt="The Direct Configuration fields for API Key and API Secret"><figcaption><p>Direct Configuration</p></figcaption></figure></div>

8. Fill **Optional Configuration**, if required.

<div data-with-frame="true"><figure><img src="https://2975852473-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FbVGYwk8aSk5yI1GDPEW9%2Fuploads%2FZbipc8nl8LTFl5YsVIaj%2Foptional-configuration.png?alt=media" alt="Reviewer Settings and fulfillment options on the Optional Configuration step"><figcaption><p>Optional Configuration</p></figcaption></figure></div>

9. Once you have filled in the information, click **Save**. Your integration is now configured and you will see the status of the integration displayed alongside other integrations on the Integrations page. When data is available, the integration Status column will read **Connected** and the integration Message will read **Data available**.

### What BalkanID extracts

You can narrow any of these under **Data Sync Preferences** when you set the integration up. Users are always synced.

| Type         | From Fivetran                                                                                                                                                         |
| ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Users**    | Every user in the account, including service accounts                                                                                                                 |
| **Roles**    | The account role catalogue, and the role each user holds                                                                                                              |
| **Teams**    | Teams and their members, with the role each member holds in the team                                                                                                  |
| **Groups**   | Destination groups and their members, with the role each member holds on the group                                                                                    |
| **API Keys** | The account's API keys, with status, expiry and last rotation. BalkanID reads the key's public identifier only — Fivetran never returns the secret                    |
| **Insights** | Findings derived from the data above, such as an expired API key, a key that has never been rotated, or an account holding both an API key and an account-scoped role |

### Integration Scopes

Fivetran does not use per-scope tokens. An API key is a key and secret pair that inherits the role of the user who generated it, so the account role you choose determines what BalkanID can read.

| Read Only Scopes                                                                                                                                        | Lifecycle Management Scopes |
| ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| **Account Administrator (Read)** — users, account roles, teams and team membership, destination groups and group membership, and the account's API keys | N/A                         |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.balkan.id/getting-started/setting-up-your-tenant/application-integrations/direct-application-integrations/fivetran-integration-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.