ContextQMD
Back to Convex Backend

Convex connector by Fivetran | Setup Guide

crates/fivetran_source/docs/setup-guide.md

latest2.6 KB
Original Source

Convex Setup Guide {% badge text="Partner-Built" /%} {% availabilityBadge connector="convex" /%}

Follow the setup guide to connect Convex to Fivetran.

NOTE: This connector is partner-built. For any questions related to Convex connector and its documentation, contact Convex's support team. For details on SLA, see Convex's Status and Guarantees documentation.

Prerequisites

To connect your Convex deployment to Fivetran, you need the following:

Setup instructions

<span class="step-item">Find your deployment credentials</span>

  1. Go to your deployment on the Convex dashboard.
  2. Go to the Production Deployment Settings.
  3. Find your deployment URL and deploy key and make a note of them. You will need them to configure Fivetran.

<span class="step-item">Finish Fivetran configuration</span>

  1. In your connection setup form, enter a Destination schema prefix. This prefix applies to each replicated schema and cannot be changed once your connection is created.
  2. Enter the Deployment URL you found.
  3. Enter your Deploy Key you found.
  4. Click Save & Test. Fivetran tests and validates our connection to your Convex deployment. Upon successful completion of the setup tests, you can sync your data using Fivetran.

Setup tests

Fivetran performs the following tests to ensure that we can connect to your Convex deployment.

<i aria-hidden="true" class="material-icons">description</i> Connector Overview

<b> </b>

<i aria-hidden="true" class="material-icons">account_tree</i> Schema Information

<b> </b>

<i aria-hidden="true" class="material-icons">home</i> Documentation Home