> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/fivetran.md).

# Fivetran

Fivetran is a managed ELT data-movement platform. Manage your Fivetran connections: create, list, pause and resume, trigger and wait for syncs, run setup tests, and check status.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector          | Authentication   |
| ------------------ | ---------------- |
| Fivetran (API Key) | API key or token |

#### Fivetran (API Key)

Connect to the Fivetran REST API with an API key and secret to manage connections: create, list, pause, sync, and check status.

**Set up in Fivetran**

1. Prepare the Fivetran account or service that the workflow will access. Grant access to the required resources and operations.
2. **API Key:** Fivetran API key. Generate a key/secret pair from the Fivetran dashboard under Account Settings > API Config.
3. **API Secret:** Fivetran API secret shown alongside the key when it is created.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Fivetran (API Key)**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                           |
| ------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API Key       | Yes      | Fivetran API key. Generate a key/secret pair from the Fivetran dashboard under Account Settings > API Config. [Provider instructions](https://fivetran.com/dashboard/account/settings). |
| API Secret    | Yes      | Fivetran API secret shown alongside the key when it is created.                                                                                                                         |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Fivetran** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Connector

Create a new Fivetran connection (source) in a destination group.

**Inputs**

| Field                    | Type             | Required | Description                                                                                                                                                                                                                                                              |
| ------------------------ | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Destination Group        | select (string)  | Yes      | The destination group the connection is created in. Options load from the selected connection.                                                                                                                                                                           |
| Source Type              | select (string)  | Yes      | The source connector type to create (e.g. 'salesforce'). Options load from the selected connection.                                                                                                                                                                      |
| Source Config            | secret           | No       | Source-specific configuration JSON for this connector type. It can hold source credentials (passwords, API keys), so values are masked.                                                                                                                                  |
| Create Paused            | boolean          | No       | Create the connection in a paused state.                                                                                                                                                                                                                                 |
| Sync Frequency (minutes) | select (integer) | No       | How often the connection syncs, in minutes. Available values: Every 1 minutes, Every 5 minutes, Every 15 minutes, Every 30 minutes, Every 60 minutes, Every 120 minutes, Every 180 minutes, Every 360 minutes, Every 480 minutes, Every 720 minutes, Every 1440 minutes. |
| Run Setup Tests          | boolean          | No       | Run setup tests after creating the connection. Default: true.                                                                                                                                                                                                            |
| Trust Certificates       | boolean          | No       | Automatically trust the source's TLS certificate.                                                                                                                                                                                                                        |
| Trust SSH Fingerprints   | boolean          | No       | Automatically trust the source's SSH fingerprint.                                                                                                                                                                                                                        |

**Outputs**

| Field             | Type    | Description                        |
| ----------------- | ------- | ---------------------------------- |
| Connection ID     | string  | ID of the created connection.      |
| Source Type       | string  | The source connector type.         |
| Destination Group | string  | The destination group ID.          |
| Paused            | boolean | Whether the connection is paused.  |
| Setup State       | string  | Setup state of the new connection. |

#### Get Connector Status

Get the sync and setup status of a Fivetran connection.

**Inputs**

| Field      | Type            | Required | Description                                                         |
| ---------- | --------------- | -------- | ------------------------------------------------------------------- |
| Connection | select (string) | Yes      | The connection to check. Options load from the selected connection. |

**Outputs**

| Field             | Type     | Description                                         |
| ----------------- | -------- | --------------------------------------------------- |
| Connection ID     | string   | The connection ID.                                  |
| Source Type       | string   | The source connector type.                          |
| Paused            | boolean  | Whether the connection is paused.                   |
| Setup State       | string   | Setup state (e.g. connected, incomplete, broken).   |
| Sync State        | string   | Sync state (e.g. scheduled, syncing, paused).       |
| Update State      | string   | Whether the connection is on schedule or delayed.   |
| Schema Status     | string   | Schema readiness status.                            |
| Historical Sync   | boolean  | Whether a historical (initial) sync is in progress. |
| Last Succeeded At | datetime | Timestamp of the last successful sync.              |
| Last Failed At    | datetime | Timestamp of the last failed sync.                  |
| Warnings          | array    | Active warnings on the connection.                  |

#### List Connectors

List Fivetran connections, optionally within one destination group.

**Inputs**

| Field             | Type            | Required | Description                                                                                  |
| ----------------- | --------------- | -------- | -------------------------------------------------------------------------------------------- |
| Destination Group | select (string) | No       | Only list connections in this destination group. Options load from the selected connection.  |
| Max Results       | integer         | No       | Maximum number of connections to return (max 1000). Minimum: 1. Maximum: 1000. Default: 100. |
| Cursor            | string          | No       | next\_cursor from a previous call, to fetch the next page.                                   |

**Outputs**

| Field       | Type          | Description                                                            |
| ----------- | ------------- | ---------------------------------------------------------------------- |
| Connections | object\_array | Connections returned for this page.                                    |
| Has More    | boolean       | Whether more connections exist beyond the returned cap.                |
| Count       | number        | Number of connections returned.                                        |
| Next Cursor | string        | Cursor for the next page of connections; empty when there are no more. |

#### Pause Connector

Pause or resume a Fivetran connection.

**Inputs**

| Field      | Type            | Required | Description                                                                   |
| ---------- | --------------- | -------- | ----------------------------------------------------------------------------- |
| Connection | select (string) | Yes      | The connection to pause or resume. Options load from the selected connection. |
| Paused     | boolean         | No       | True to pause the connection, false to resume it. Default: true.              |

**Outputs**

| Field         | Type    | Description                                     |
| ------------- | ------- | ----------------------------------------------- |
| Connection ID | string  | The connection ID.                              |
| Paused        | boolean | The connection's paused state after the update. |
| Source Type   | string  | The source connector type.                      |

#### Trigger Connector Sync

Trigger a manual sync of a Fivetran connection.

**Inputs**

| Field      | Type            | Required | Description                                                         |
| ---------- | --------------- | -------- | ------------------------------------------------------------------- |
| Connection | select (string) | Yes      | The connection to sync. Options load from the selected connection.  |
| Force      | boolean         | No       | Interrupt any in-progress sync and start a new one. Default: false. |

**Outputs**

| Field         | Type    | Description                         |
| ------------- | ------- | ----------------------------------- |
| Connection ID | string  | The connection ID.                  |
| Triggered     | boolean | Whether the sync was accepted.      |
| Message       | string  | Confirmation message from Fivetran. |

#### Sync and Wait

Trigger a sync and wait for it to finish (up to a time budget).

**Inputs**

| Field              | Type            | Required | Description                                                                          |
| ------------------ | --------------- | -------- | ------------------------------------------------------------------------------------ |
| Connection         | select (string) | Yes      | The connection to sync. Options load from the selected connection.                   |
| Force              | boolean         | No       | Interrupt any in-progress sync and start a new one. Default: false.                  |
| Max Wait (seconds) | integer         | No       | How long to wait for completion (max 300s). Minimum: 15. Maximum: 300. Default: 300. |

**Outputs**

| Field            | Type    | Description                                                      |
| ---------------- | ------- | ---------------------------------------------------------------- |
| Connection ID    | string  | The connection ID.                                               |
| Completed        | boolean | Whether the sync finished within the wait window.                |
| Succeeded        | boolean | Whether the finished sync succeeded (null if it did not finish). |
| Sync State       | string  | The connection's sync state at the last poll.                    |
| Message          | string  | Human-readable outcome summary.                                  |
| Waited (seconds) | number  | How long the action waited before returning.                     |

#### Delete Connector

Delete a Fivetran connection.

**Inputs**

| Field      | Type            | Required | Description                                                          |
| ---------- | --------------- | -------- | -------------------------------------------------------------------- |
| Connection | select (string) | Yes      | The connection to delete. Options load from the selected connection. |

**Outputs**

| Field         | Type    | Description                         |
| ------------- | ------- | ----------------------------------- |
| Connection ID | string  | The connection ID.                  |
| Deleted       | boolean | Whether the connection was deleted. |
| Message       | string  | Confirmation message from Fivetran. |

#### Resync Connector

Trigger a historical re-sync of a Fivetran connection.

**Inputs**

| Field      | Type            | Required | Description                                                                        |
| ---------- | --------------- | -------- | ---------------------------------------------------------------------------------- |
| Connection | select (string) | Yes      | The connection to re-sync from scratch. Options load from the selected connection. |
| Scope      | object          | No       | Optional map of schema name to the tables to re-sync.                              |

**Outputs**

| Field         | Type    | Description                         |
| ------------- | ------- | ----------------------------------- |
| Connection ID | string  | The connection ID.                  |
| Triggered     | boolean | Whether the re-sync was accepted.   |
| Message       | string  | Confirmation message from Fivetran. |

#### Run Setup Tests

Run the setup tests for a Fivetran connection.

**Inputs**

| Field                  | Type            | Required | Description                                                        |
| ---------------------- | --------------- | -------- | ------------------------------------------------------------------ |
| Connection             | select (string) | Yes      | The connection to test. Options load from the selected connection. |
| Trust Certificates     | boolean         | No       | Automatically trust the source's TLS certificate during the test.  |
| Trust SSH Fingerprints | boolean         | No       | Automatically trust the source's SSH fingerprint during the test.  |

**Outputs**

| Field         | Type          | Description                          |
| ------------- | ------------- | ------------------------------------ |
| Connection ID | string        | The connection ID.                   |
| All Passed    | boolean       | Whether every setup test passed.     |
| Setup State   | string        | Setup state after running the tests. |
| Tests         | object\_array | Individual setup-test results.       |

#### List Groups

List Fivetran destination groups.

**Inputs**

| Field       | Type    | Required | Description                                                                             |
| ----------- | ------- | -------- | --------------------------------------------------------------------------------------- |
| Max Results | integer | No       | Maximum number of groups to return (max 1000). Minimum: 1. Maximum: 1000. Default: 100. |
| Cursor      | string  | No       | next\_cursor from a previous call, to fetch the next page.                              |

**Outputs**

| Field       | Type          | Description                                                       |
| ----------- | ------------- | ----------------------------------------------------------------- |
| Groups      | object\_array | Destination groups returned.                                      |
| Has More    | boolean       | Whether more groups exist beyond the returned cap.                |
| Count       | number        | Number of groups returned.                                        |
| Next Cursor | string        | Cursor for the next page of groups; empty when there are no more. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# 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.stackai.com/integrations/catalog/fivetran.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.
