No menu items for this category

Run the Fivetran Connector Externally

Pipeline Status

In this section, we provide guides and references to use the Fivetran connector.

Configure and schedule Fivetran metadata and profiler workflows from the OpenMetadata UI:

To run the Ingestion via the UI you'll need to use the OpenMetadata Ingestion Container, which comes shipped with custom Airflow plugins to handle the workflow deployment.

If, instead, you want to manage your workflows externally on your preferred orchestrator, you can check the following docs to run the Ingestion Framework anywhere.

OpenMetadata 0.12 or later

To deploy OpenMetadata, check the Deployment guides.

To access Fivetran APIs, a Fivetran account on a Standard, Enterprise, or Business Critical plan is required.

To run the Fivetran ingestion, you will need to install:

All connectors are defined as JSON Schemas. Here you can find the structure to create a connection to Fivetran.

In order to create and run a Metadata Ingestion workflow, we will follow the steps to create a YAML configuration able to connect to the source, process the Entities if needed, and reach the OpenMetadata server.

The workflow is modeled around the following JSON Schema

This is a sample config for Fivetran:

apiKey: Fivetran API Key.

Follow the steps mentioned below to generate the Fivetran API key and API secret:

  • Click your user name in your Fivetran dashboard.
  • Click API Key.
  • Click Generate API key. (If you already have an API key, then the button text is Generate new API key.)
  • Make a note of the key and secret as they won't be displayed once you close the page or navigate away.

For more detailed documentation visit here.

apiSecret: Fivetran API Secret.

From the above step where the API key is generated copy the the API secret

hostPort: HostPort of the Fivetran instance.

Hostport of the Fivetran instance that the connection will be made to By default OpenMetadata will use to connect to the Fivetran APIs.

limit: Fivetran API Limit For Pagination.

This refers to the maximum number of records that can be returned in a single page of results when using Fivetran's API for pagination.

The sourceConfig is defined here:

dbServiceNames: Database Service Name for the creation of lineage, if the source supports it.

includeTags: Set the 'Include Tags' toggle to control whether to include tags as part of metadata ingestion.

markDeletedPipelines: Set the Mark Deleted Pipelines toggle to flag pipelines as soft-deleted if they are not present anymore in the source system.

pipelineFilterPattern and chartFilterPattern: Note that the pipelineFilterPattern and chartFilterPattern both support regex as include or exclude.

To send the metadata to OpenMetadata, it needs to be specified as type: metadata-rest.

The main property here is the openMetadataServerConfig, where you can define the host and security provider of your OpenMetadata installation.

Logger Level

You can specify the loggerLevel depending on your needs. If you are trying to troubleshoot an ingestion, running with DEBUG will give you far more traces for identifying issues.

JWT Token

JWT tokens will allow your clients to authenticate against the OpenMetadata server. To enable JWT Tokens, you will get more details here.

You can refer to the JWT Troubleshooting section link for any issues in your JWT configuration.

SSL Configuration

If you have added SSL to the OpenMetadata server, then you will need to handle the certificates when running the ingestion too. You can either set verifySSL to ignore, or have it as validate, which will require you to set the sslConfig.certificatePath with a local path where your ingestion runs that points to the server certificate file.

Find more information on how to troubleshoot SSL issues here.


First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.