Create a Connection from the Dashboard Private Preview

By using a setup form, you can collect configuration values in the Fivetran dashboard and let users create connections right in their browsers.

To deploy connections from the dashboard, mark your connector package as visible and then select it in the dashboard. For details on setting package visibility, see Managing Connector Packages. In the package's setup form, enter your configuration values and save the connection.

Prerequisites

• A Connector SDK connector with a setup form. Define it by implementing the configuration_form() method and passing it to the Connector object.
• A pyproject.toml file in your project that defines the package name and sets visibility to true. For details, see Managing Connector Packages.
• A destination in your Fivetran account.
• A Fivetran API key.

How to create a connection in your dashboard

Before you proceed, ensure your package is ready and deployed. For details on configuring package visibility and deploying your connector, see Managing Connector Packages.

1. In the Fivetran dashboard, go to Connections, and then click Add connection.
2. In Browse our connectors, find your package under All connectors or Custom connectors. You can select it from the list or search for it by package name. Your package appears with the Connector SDK logo and a Connector SDK label.
3. Select your package, select your destination, and then click Set up.
4. Complete the setup form. The form contains the following fields:
   • Fivetran-defined fields.
   • The custom fields that you defined in your package's configuration_form() method.
5. Run the setup tests and save the connection.

Fivetran creates the connection and starts syncing it based on your configuration. A connection created through the setup form behaves the same way as a connection created with fivetran deploy.