API Tools

The following tools and code sample libraries let you use the Fivetran REST API in a more efficient and easy way:

• Fivetran Postman collection
• Fivetran provider for Apache Airflow
• Fivetran provider for Terraform
• Fivetran Webhooks project

Fivetran Postman collection

Postman is a very popular and convenient API client that makes it easy for developers to create, share and test API requests. You can use Fivetran's ready-made Postman collection to test API endpoints within your account. The collection contains templates to help you create API calls for all endpoints supported by Fivetran.

To use our Postman collection:

1. Download and install Postman.

2. Download and then import our Postman Collection.

   NOTE: Log in to your Postman account prior to starting the collection import.

   

   Once the collection is imported, the following API requests will appear on the Collections tab.

   

3. Configure the authorization in Postman.

   i. Hover over the imported Fivetran REST API collection.

   ii. Click the menu icon ( ... ).

   iii. Click Edit in the displayed menu. The Edit Collection page opens.

   iv. Select the Variables tab.

   v. Specify your API key and secret in unencoded format in the corresponding Current Value fields. You can find them in your Fivetran account settings. See our REST API documentation to learn how to get your API key and secret. Postman encodes the API key and secret to base64 when calling an endpoint.

   vi. Click Save to save the changes.

   

   IMPORTANT: Don't share your key and secret. Remember that the exported collection may contain sensitive information in its parameters.

When you complete the collection import and configuration, you will be able to run the API requests. Most of the requests require path or payload parameters that are enclosed in {}. You need to populate the parameters according to your needs.

Fivetran provider for Apache Airflow

Apache Airflow is an open-source workflow management platform for data engineering pipelines that lets you programmatically author, schedule, and monitor workflows.

Providers are plugins that you can add to your configuration and use the resources of cloud platforms and services to provision infrastructure.

We have partnered with Astronomer to support an open-source async Fivetran provider for Airflow. If you have a provider-specific issue, raise an issue on the Github repo. If you have a Fivetran-related issue, create a support ticket.

See the Fivetran provider for Apache Airflow for details.

Our previous provider will be deprecated. See our migration guide.

Fivetran provider for Terraform

Terraform is an infrastructure-as-code (IaC) software tool that provides a command-line interface (CLI) workflow to manage cloud services. Terraform codifies cloud APIs into declarative configuration files.

Providers are plugins that you can add to your configuration and use the resources of cloud platforms and services to provision infrastructure.

See the Fivetran provider for Terraform page for details.

Fivetran Webhooks project

Webhooks are automated notifications sent from an application when an event occurs. Our webhooks test project is a simple example that demonstrates how to ingest webhooks from Fivetran.