Skip to main content
In this section, we provide guides and references to use the Fivetran connector. Configure and schedule Fivetran metadata workflows from the Collate UI:

​
Requirements

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

​
Permissions

Generate the API key and API secret from a Fivetran user with an account-level role that has read access to all destinations and connections, such as Account Reviewer. Collate needs to discover every destination and connector in the account. A destination-scoped role (for example, View Destination) is not enough, because it only covers destinations the user was explicitly invited to. For detailed, per-phase Pipeline Status (Extract/Process/Load), Collate also reads the fivetran_metadata.log table that Fivetran automatically publishes in each destination’s warehouse, using the Database Service already connected to that warehouse in Collate. The database user in that connection needs SELECT access to the fivetran_metadata.log table, along with whatever database- or schema-level privileges your warehouse requires to reach it (for example, USAGE on the schema/database in Snowflake). If this table isn’t reachable, Collate automatically falls back to Fivetran’s REST sync-history API for pipeline status.

​
Metadata Ingestion

​
Connection Details

1

Connection Details

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 API secret
  • hostPort: HostPort of the Fivetran instance. By default, OpenMetadata will use https://api.fivetran.com 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.
2

Test the Connection

Once the credentials have been added, click on Test Connection and Save the changes.Test Connection
3

Configure Metadata Ingestion

In this step we will configure the metadata ingestion pipeline, Please follow the instructions belowConfigure Metadata Ingestion

​
Metadata Ingestion Options

  • Name: This field refers to the name of ingestion pipeline, you can customize the name or use the generated name.
  • Pipeline Filter Pattern (Optional): Use to pipeline filter patterns to control whether or not to include pipeline as part of metadata ingestion.
    • Include: Explicitly include pipeline by adding a list of comma-separated regular expressions to the Include field. OpenMetadata will include all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be excluded.
    • Exclude: Explicitly exclude pipeline by adding a list of comma-separated regular expressions to the Exclude field. OpenMetadata will exclude all pipeline with names matching one or more of the supplied regular expressions. All other schemas will be included.
  • Include lineage (toggle): Set the Include lineage toggle to control whether to include lineage between pipelines and data sources as part of metadata ingestion.
  • Enable Debug Log (toggle): Set the Enable Debug Log toggle to set the default log level to debug.
  • Mark Deleted Pipelines (toggle): Set the Mark Deleted Pipelines toggle to flag pipelines as soft-deleted if they are not present anymore in the source system.
4

Schedule the Ingestion and Deploy

Scheduling can be set up at an hourly, daily, weekly, or manual cadence. The timezone is in UTC. Select a Start Date to schedule for ingestion. It is optional to add an End Date.Review your configuration settings. If they match what you intended, click Deploy to create the service and schedule metadata ingestion.If something doesn’t look right, click the Back button to return to the appropriate step and change the settings as needed.After configuring the workflow, you can click on Deploy to create the pipeline.Schedule the Workflow
5

View the Ingestion Pipeline

Once the workflow has been successfully deployed, you can view the Ingestion Pipeline running from the Service Page.View Ingestion Pipeline
If AutoPilot is enabled, workflows like usage tracking, data lineage, and similar tasks will be handled automatically. Users don’t need to set up or manage them - AutoPilot takes care of everything in the system.
When using a Hybrid Ingestion Runner, any sensitive credential fields—such as passwords, API keys, or private keys—must reference secrets using the following format:
This applies only to fields marked as secrets in the connection form (these typically mask input and show a visibility toggle icon). For a complete guide on managing secrets in hybrid setups, see the Hybrid Ingestion Runner Secret Management Guide.

​
Troubleshooting

Fivetran Troubleshooting

Learn more about how to troubleshoot common Fivetran connector issues and resolve configuration or ingestion errors.