Fivetran

Sifflet connects to your Fivetran account to show the state of the connectors that load data into your data platform. Each connector appears in the Data Catalog with its status (active, paused, delayed, broken), its sync frequency, and the date of its last successful sync, so you can see at a glance which connectors are broken, paused, or late, and whether the data they load into your data platform is up to date. See Fivetran Collected Data for everything Sifflet imports.

Permissions Required

Sifflet uses a Fivetran API key and secret to call the Fivetran REST API with read-only requests. It never creates, edits, pauses, or triggers connectors.

Fivetran API keys are scoped: a key has the role-based access control (RBAC) permissions of the Fivetran user who generates it. Sifflet only sees the destinations (groups) and connectors that this user can access.

PermissionUsed forRequired
Read access to the destinations (groups) to monitor: GET /v1/groups, GET /v1/destinations/{group_id}List the destinations and their platformYes
Read access to the connectors to monitor: GET /v1/groups/{group_id}/connectorsImport connectors, their status, sync frequency, and last successful syncYes
Read access to the account's users: GET /v1/usersShow the name of the user who created each connectorOptional (connector creator)

Ingestions don't consume any Fivetran usage (Monthly Active Rows).

Requirements

Required Roles for Setup

  • In Fivetran: a user who can create a Fivetran user for Sifflet and grant it access to the destinations and connectors to monitor (for example, an Account Administrator).
  • In Sifflet: the Admin system role to create the credential, and the Admin or System Editor system role to create the source. See Access Control.

Supported Versions and Editions

All Fivetran plans that give access to the Fivetran REST API.

Network Access

Sifflet connects to the Fivetran API (https://api.fivetran.com) over the internet.

Connect Sifflet to Fivetran

Step 1: Create an API Key in Fivetran

  1. In Fivetran, create a dedicated user for Sifflet, for example sifflet@<YOUR_DOMAIN>, and give it access to the destinations and connectors you want to monitor, with a role that doesn't allow changes (see Fivetran RBAC). To show connector creators in Sifflet, also give it read access to the account's users.
  2. Log in to Fivetran as this user and generate an API key and secret, following the Fivetran documentation.
  3. Copy the API key and the API secret: Fivetran shows the secret only once. Generating a new key invalidates the previous one, so update the Sifflet credential whenever you regenerate it.

Step 2: Add the Fivetran Source in Sifflet

Create the Credential

In Integrations > Credentials, create a new credential with the following JSON value, where user is the API key and password is the API secret:

{
  "user": "<FIVETRAN_API_KEY>",
  "password": "<FIVETRAN_API_SECRET>"
}

Create the Source

  1. Go to Integrations > Sources > New source and choose Fivetran.

  2. Fill in the fields:

    FieldDescriptionExample
    Source nameName of the source in SiffletFivetran
    HostURL of the Fivetran API, with https:// and without a trailing path. Keep the default valuehttps://api.fivetran.com
    CredentialsThe credential created abovefivetran-api-key

    The source imports all the connectors the API key can access: there is no scope to select. To exclude connectors, restrict the access of the Fivetran user (step 1).

  3. In Set frequency, keep the default schedule or change it. See Integrations Management.

  4. Click Test connection: Sifflet checks that it can list the destinations with the API key. Then save the source.

Sifflet runs a first ingestion, which usually takes a few minutes. You can follow it in the source details, in Integrations > Sources. Once it succeeds, your connectors appear in the Data Catalog.

Troubleshooting

Test Connection Fails

Symptom: Test connection or the ingestion fails with an error such as:

Fivetran API request failed [uri: /v1/groups?limit=100, status: 401 UNAUTHORIZED, body: ...]

Cause: the API key or secret is wrong or was regenerated, or the credential doesn't use the user and password keys.

Fix:

  1. Check the credential format. See Create the Credential.
  2. If the key was regenerated in Fivetran, update the credential with the new key and secret.

Some Connectors Are Missing

Symptom: the ingestion succeeds, but some connectors don't appear in the Data Catalog.

Cause: the Fivetran user who generated the API key doesn't have access to their destination or connector.

Fix:

  1. Give the Fivetran user access to the missing destinations and connectors. See Step 1.
  2. Run the source again from Integrations > Sources.

Did this page help you?