Release Noteslink

November 2023link

We have renamed the api_key:api_secret parameter of the Revel Systems connector to api_key_api_secret.

Our Log Service Management API resource is now generally available. You can now leverage the following features:

• Create a Log Service
• Retrieve Log Service Details
• Update a Log Service
• Delete a Log Service
• Run Log Service Setup Tests

Our Private Links Management API resource is now beta. You can now leverage the following features:

• Create a Private Link
• List all Private Links within Group
• Retrieve Private Link Details
• Update a Private Link
• Delete a Private Link

October 2023link

Now, you can configure the API usage limit of the Kustomer connector using our REST API. Previously, the default API usage limit was 90%. For more information, see our Kustomer API Configuration documentation.

September 2023link

You can now specify secrets as key-pair values when you configure the Azure Functions connector using our REST API.

You can now specify secrets as key-pair values when you configure the Google Cloud Functions connector using our REST API.

We have implemented new Group Management API endpoints for our REST API. You can now leverage the following new features:

• Retrieve group public SSH key
• Retrieve group service account

August 2023link

We have added the Log Service Management API and Transformations for dbt Core Management API to our Postman collection.

Our dbt Transformations Management API is now Beta. You can now leverage the following features:

• Create dbt Project
• Retrieve dbt Projects
• Retrieve dbt Project details
• Test dbt Project
• Retrieve dbt Project Models
• Retrieve dbt Project Model details
• Create dbt Transformation
• Retrieve dbt Transformations
• Retrieve dbt Transformation details
• Modify dbt Transformation
• Delete dbt Transformation
• Cancel dbt Transformation
• Run dbt Transformation
• Pause dbt Transformation
• Resume dbt Transformation

You can now specify the events and custom events that you want to sync when you configure the Iterable connector using our REST API.

Our Webhook Management API is now generally available.

We have changed the Salesfore connector's API response to the Retrieve Connector Details API request to return the connecting_user_email, organization_id, and username fields in the config section of the response instead of the source_sync_details section.

• For the Transformations for dbt Core Management API, we added a new field, environment_vars. You can now manage the list of environment variables defined as key-value pairs.

• The enabled field in the Log Service Management API's Create a Log Service method now has the true value by default.

• We added a new field, connector_class, in the Retrieve connector types and Retrieve connector type details methods. This field contains the connector category (standard or lite). Learn more about connector categories in our Differences between Standard and Lite connectors documentation.

Our Log Service Management API resource is now in beta. You can now leverage the following features:

• Create a Log Service
• Retrieve Log Service Details
• Update a Log Service
• Delete a Log Service
• Run Log Service Setup Tests

Fivetran provider for Terraform is now generally available.

We now validate that the external_id value that you specify when creating the Amazon S3 connector using the REST API is the same as your Fivetran account's group_id. Make sure to choose any of the group_id from your Fivetran account as the external_id parameter value. To find the group_id, use the List All Groups endpoint.

July 2023link

We have changed the response code for the Delete Webhook endpoint from HTTP 204 to HTTP 200.

We now support the following new webhook events:

• connection_successful
• connection_failure
• create_connector
• pause_connector
• resume_connector
• edit_connector
• delete_connector
• force_update_connector
• resync_connector
• resync_table

We have made the active field optional in the Сreate Account Webhook and Create Group Webhook endpoint requests. By default, the field value is set to true.

We have implemented two new endpoints in our REST API, Retrieve Function Connector State and Update Function Connector State that allow you to get and update the state of function connectors, respectively.

You can now opt to sync Salesforce formula fields using our REST API. For more information, see our API Configuration documentation.

We have updated the Adobe Analytics connector's REST API configuration parameters to support aggregating data by week. Learn more in our Adobe Analytics Connector Config documentation.

June 2023link

You can now configure the API usage limit of the Qualtrics connector using our REST API. For more information, see our Qualtrics API Configuration documentation.

Now, when you configure the AWS Lambda connector using our REST API, you can:

• Connect using AWS PrivateLink if your Lambda function and destination are in the same AWS Region. This feature is available only on the Business Critical plan.
• Select your sync method. You can opt to sync directly or through an S3 bucket.

We now support the edit_connector webhook event for manual or automatic connector status changes. Namely, this webhook event is raised for setup-state and schema-status property changes, which are reflected in editType.

The following edit_connector webhook events are shown below as being relevant for the How to Capture a Connector Schema and Set up Data You Want to Replicate to Your Destination before the Initial Sync use case.

{
    event: 'edit_connector',
    // ...
    editType: 'UPDATE_SETUP_STATE',
    properties: { setupState: 'connected' },
    oldProperties: { setupState: 'incomplete' }
}
{
  event: 'edit_connector',
  // ...
  editType: 'UPDATE_SETUP_STATE',
  properties: { setupState: 'broken' },
  oldProperties: { setupState: 'connected' }
}
{
    event: 'edit_connector',
    // ...
    editType: 'UPDATE_SCHEMA_STATUS',
    properties: { schemaStatus: 'blocked_on_capture' },
    oldProperties: { schemaStatus: 'ready' }
}
{
    event: 'edit_connector',
    // ...
    editType: 'UPDATE_SCHEMA_STATUS',
    properties: { schemaStatus: 'blocked_on_customer' },
    oldProperties: { schemaStatus: 'blocked_on_capture' }
}
{
    event: 'edit_connector',
    // ...
    editType: 'UPDATE_SCHEMA_STATUS',
    properties: { schemaStatus: 'ready' },
    oldProperties: { schemaStatus: 'blocked_on_customer' }
}
content_copy

May 2023link

Now, we deactivate a webhook if it consistently fails for more than three days and only responds with non-2xx codes. To activate the webhook, ensure that the setup is correct by retrieving the webhook details and updating them with corrected information along with passing "active": true in the request. Alternatively, you can create a new webhook.

March 2023link

We have added the following new fields to the response for our REST API Webhook endpoints:

• code
• message
• data

The data field contains all fields returned in the response in the old format.

An example of the previous response format:

{
  "id": "program_quoth",
  "type": "account",
  "url": "https://your-host.your-domain/webhook",
  "events": [
    "sync_start",
    "sync_end"
  ],
  "active": true,
  "secret": "******",
  "created_at": "2022-04-29T09:41:08.583Z",
  "created_by": "_airworthy"
}
content_copy

An example of the new response format:

{
  "code": "Success",
  "message": "Account webhook has been created",
  "data": {
    "id": "program_quoth",
    "type": "account",
    "url": "https://your-host.your-domain/webhook",
    "events": [
      "sync_start",
      "sync_end"
    ],
    "active": true,
    "secret": "******",
    "created_at": "2022-04-29T09:41:08.583Z",
    "created_by": "_airworthy"
  }
}
content_copy

Fivetran now takes into account all connectors specifics and returns the correct name_in_destination field value for schemas in the response for the following REST API endpoints:

• Retrieve a Connector Schema Config
• Reload a Connector Schema Config
• Modify a Connector Schema Config
• Modify a Connector Database Schema Config
• Modify a Connector Table Config
• Modify a Connector Column Config

Previously, we returned the schema name only with the generic naming rules applied.

For the service parameter in the API request for our Databricks destination, you now need to specify databricks as a value. The old values databricks_aws and databricks_azure are still valid.

January 2023link

You can now generate scoped API keys to use with our REST API.

November 2022link

Now, you can configure the API usage limit of the Zendesk Support connector using our REST API. Previously, the default API usage limit was 90%. For more information, see our Zendesk Support API Configuration documentation.

In the LinkedIn Ad Analytics REST API configuration, we have removed the 90-day option from the postClickAttributionWindowSize and viewThroughAttributionWindowSize fields because data older than 30 days cannot be updated.

You can now specify secrets as key-pair values when you configure the Lambda connector using our REST API.

October 2022link

We have added the schema_status parameter to our Modify a Connector endpoint. You can use it to capture the connector schema before the initial sync. For more information, see our documentation.

August 2022link

We have added a new icons field to the Retrieve source metadata and Retrieve connector configuration metadata endpoint responses. This field contains a list of additional icon URLs in different formats (for example, .svg or .png) for the connector.

We have changed the retry algorithm for sending webhooks. We now use an exponential backoff strategy - we wait 6 minutes before the first retry, 21 minutes before the second retry, and so on. Learn more in our Retries documentation.

We have added a new check that we perform during the webhook creation or activation. The endpoint specified in the payload should exist and return a successful HTTP code. Otherwise, we will return an HTTP 400 Bad Request error.

July 2022link

We have added the Webhook management endpoints to our Postman collection.

We have implemented email notification that informs you about webhook event sending failure. To turn it on, go to Account notifications page and change the Receive an email when webhook events failed to be sent value.

We have added two new optional parameters, is_account_level_connector and group, to the Fivetran Platform Connector REST API Request. You can now opt to retrieve account-level logs.

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the Intercom connector by adding the auth section to payloads.

June 2022link

In the sync mode parameter of the Google Campaign Manager 360 API configuration, we replaced the following:

• AllAccounts value with ALL_PROFILES
• SpecificAccounts value with SPECIFIC_PROFILES

May 2022link

We have implemented a new API endpoint for our REST API, Re-sync Connector Data (Historical Sync), that allows you to trigger a full historical sync of a connector or multiple schema tables within a connector.

We have updated the Sync Connector Data endpoint with a new path, sync. We also added a new payload parameter, force, that allows you to force a sync, even if a sync is already in progress.

April 2022link

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the Google Search Console connector by adding the auth section to payloads.

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the YouTube Analytics connector by adding the auth section to payloads.

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the Twitter Organic connector by adding the auth section to payloads.

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the Pinterest Ads connector by adding the auth section to payloads.

We have implemented the following new API endpoints for our REST API:

• New resources: Team Management Private Preview

• New endpoints in User Management: Connector memberships Private Preview

We have expanded the Create a Connector and Modify a Connector endpoints of our REST API. Now you can authorize the Verizon Media connector by adding the auth section to payloads.

We have implemented a new resource, Webhook Management, for our REST API. This feature is in beta. You can now leverage the following new features:

• Create account webhook
• Create group webhook
• Retrieve webhook details
• Update webhook
• Delete webhook
• Retrieve the list of webhooks
• Test webhook

March 2022link

We've updated the REST API config format for the Google Ads connector. See the Google Ads configuration section in our REST API documentation for details.

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the Zoho CRM connector by adding the auth section to payloads.

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the Instagram Business connector by adding the auth section to payloads.

February 2022link

We have added the following new regions:

• GCP_US_EAST4
• GCP_US_WEST1
• GCP_EUROPE_WEST3
• GCP_AUSTRALIA_SOUTHEAST1
• GCP_NORTHAMERICA_NORTHEAST1
• GCP_EUROPE_WEST2
• GCP_ASIA_SOUTHEAST1
• AWS_US_EAST_1
• AWS_US_EAST_2
• AWS_US_WEST_2
• AWS_AP_SOUTHEAST_2
• AWS_EU_CENTRAL_1
• AWS_EU_WEST_1
• AWS_EU_WEST_2
• AZURE_EASTUS2
• AZURE_AUSTRALIAEAST
• GCP_ASIA_SOUTH1

We have deprecated the following regions:

• US
• EU
• APAC
• UK
• CANADA
• SINGAPORE

We have changed the Add a User to a Group API response message to more accurately reflect the action performed.

Before:

{
    "code": "Success",
    "message": "User has been invited to the group"
}
content_copy

Now:

{
    "code": "Success",
    "message": "User has been added to the group"
}
content_copy

January 2022link

We have implemented the following new API endpoints for our REST API:

New resources: Role Management Beta

New endpoints in User Management:

• Group memberships Beta
• Delete user role in account

December 2021link

We now use connector-types instead of connectors in the paths for the following metadata endpoints:

• Retrieve source metadata - the new path format is as follows: https://api.fivetran.com/v1/metadata/connector-types
• Retrieve connector config metadata - the new path format is as follows: https://api.fivetran.com/v1/metadata/connector-types/{connector_type}

We support the old path format for backward compatibility. The sunset date for the old path format is April 1, 2022.

We have removed the Show button in the API config section on the Security tab of your Account Management page. Click the Generate button to view your API key and secret.

Click Generate new secret to generate a new API secret and replace the existing secret.

October 2021link

We now return the connector_id field in the Connect Card token endpoint response.

For more information, see our Connect Card documentation.

For improved security, we will remove the Show button in the API config section on the Security tab of your Account Management page.

The API key and secret are essentially credentials that allow you to access your account using the API. Never share your API key or secret with anyone.

September 2021link

You can now re-sync data for multiple tables using the Re-sync Connector Table Data endpoint.

For accounts created after September 9, 2021, we return the connector configuration response in the V2 format by default.

See our Retrieve Connector Details endpoint documentation for details.

We have implemented a new API endpoint for our REST API, Retrieve connector configuration metadata.

August 2021link

We have added validation for the schema and table path parameters for the Re-sync Connector Table Data endpoint. For a request to succeed, you need to specify its parameters correctly.

When you call this endpoint with an incorrect schema value, you receive the following error:

HTTP 404
"message" : "Cannot find entity 'Schema' with id '<your_connector_schema_id>'."
content_copy

NOTE: Your previously successful request may fail with the error, indicating that you have been using the wrong schema value.

You can find the name of your database schema and table on the Schema tab of the connector details page.

NOTE: Make sure you don't use the connector schema name instead of the database schema name.

See our Re-sync Connector Table Data endpoint documentation for details.

July 2021link

We have expanded the current public API endpoints Create a connector and Modify a Connector. Now, you can create or modify the connector that will be paused after the trial period by specifying the pause_after_trial request parameter.

We have implemented a new format (V2) for consistency in the destination configuration information. This format is valid for the following destinations:

• Azure Synapse
• MySQL
• PostgreSQL
• Redshift
• SQL Server

For more information, see our V2 config format documentation.

We have changed the data type of the picture field defining the user avatar to STRING. Now, we support both image URL (for example, http://mycompany.com/avatars/john_white.png) and Base64 data URI (for example, data:image/png;base64,aHR0cDovL215Y29tcGFueS5jb20vYXZhdGFycy9qb2huX3doaXRlLnBuZw==) values for this field.

See our User Management endpoint documentation.

We now display the role field for each user in the response for the following endpoints:

• Retrieve user details
• Invite a user
• Modify a user
• List all users within a group

June 2021link

We now display the role field for each user in the response for the List All Users endpoint.

We have implemented a new Group Management API endpoint for our REST API. You can now leverage the new Modify a group feature.

We have expanded the Create a connector endpoint. Now, you can:

• set the frequency of your syncs using the sync_frequency request parameter
• set the start time of your daily syncs using the daily_sync_time request parameter if you set the sync_frequency parameter to 1440

May 2021link

We have implemented a new Group Management API endpoint for our REST API. You can now leverage the new Delete a group feature.

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the Asana connector by adding the auth section to payloads.

April 2021link

We have published Postman collection, which contains templates to help you create API requests for all endpoints supported by Fivetran.

We have added a schema filter to our List All Connectors within a Group endpoint. Specify the schema of a connector as a value of the schema GET parameter to perform filtering and retrieve only information for that connector.

We have expanded the Create a Connector and Modify a Connector public API endpoints. Now you can authorize the following connectors by adding the auth section to payloads:

• Microsoft Advertising
• Snapchat Ads

March 2021link

We now display the name_in_destination field for each schema, table, and column in the response for the following endpoints:

• Retrieve a connector schema config
• Retrieve source table columns config
• Reload a connector schema config
• Modify a connector schema config
• Modify a connector database schema config
• Modify a connector table config
• Modify a connector column config

Now, you can set the time your daily syncs start using the daily_sync_time request parameter for the Modify a Connector endpoint.

We have implemented new API endpoints for our REST API:

Destination Managementlink

• Run destination setup tests

Certificate Managementlink

• Approve a destination certificate
• Approve a destination fingerprint

You can also approve certificates and fingerprints automatically by specifying true as a value of the new trust_certificates and trust_fingerprints parameters in the existing Destination Management API endpoints:

• Create a destination
• Modify a destination

February 2021link

Our Jira connector no longer uses the use_webhooks configuration field.

January 2021link

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the following connectors by adding the auth section to payloads:

• QuickBooks
• Shopify

We have introduced a new (v2) connector configuration return format for the following endpoints:

• Retrieve Connector Details
• Create a Connector
• Modify a Connector
• Run connector setup tests

We have implemented a new Certificate Management API endpoint for our REST API. You can now leverage the new Approve a connector fingerprint feature.

You can also approve fingerprints automatically by specifying true as a value of the new trust_fingerprints parameter in the existing Connector Management API endpoints:

• Create a connector
• Modify a connector
• Run connector setup tests

December 2020link

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the following connectors by adding the auth section to payloads:

• AdRoll
• Facebook Pages
• Front
• Google Ad Manager
• Help Scout
• LinkedIn Ad Analytics
• Optimizely
• Pipedrive
• SurveyMonkey
• Zendesk Chat
• Zendesk Support

We have implemented new Connector and Destination Management API endpoints for our REST API. You can now leverage the following new features:

• Delete a destination
• Retrieve source metadata

November 2020link

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the following connectors by adding the auth section to payloads:

• Google Campaign Manager 360
• Google Ads
• Google Analytics
• Google Analytics (MCF)
• Google Sheets
• HubSpot

October 2020link

We have expanded the public API endpoints Create a Connector and Modify a Connector. Now you can authorize the following connectors by adding the auth section to payloads:

• Microsoft Dynamics 365 CRM
• Salesforce

We have made changes to all public API endpoints that return the table and column configs as a response. Now you can see patch settings information for tables and columns in the response. It may help you understand whether you are allowed to enable or disable sync for them in the connector standard config. See the documentation for the following endpoints to learn more about the patch settings:

• Retrieve a Connector Schema Config
• Retrieve source table columns config
• Reload a connector schema config
• Modify a connector schema config
• Modify a connector database schema config
• Modify a connector table config
• Modify a connector column config

September 2020link

We have added a new optional parameter, hide_setup_guide, to our Connect Card. It lets you hide the embedded setup guide.

We have implemented a new Connector Management API endpoint for our REST API. You can now leverage the new Retrieve Source Table Columns Config feature.

August 2020link

We have expanded the current public API endpoint Reload a Connector Schema Config. Now, you can enable or disable all schemas, tables and columns in the standard config by specifying the exclude_mode parameter in payloads.

Our Databricks REST API endpoint now supports the creation of external tables. You can now opt to create Delta tables as external tables for your Databricks implementations.

We made our REST API available for all Trial accounts. To learn about limitations for Trials as compared to Standard and Enterprise accounts, read our rate-limiting documentation.

We have updated the REST API configuration parameters to support new authentication mechanisms for the following connectors:

• Adobe Analytics now supports JSON Web Token (JWT) Authentication. See our Adobe Analytics Connector Config documentation for more information.
• Twilio now supports authentication using API Keys. See our Twilio Connector Config documentation for more information.

July 2020link

We have implemented new Destination Management API endpoints for our REST API. You can now leverage the new Retrieve Destination Details feature.

We have expanded the current public API endpoint Create a Connector. Now, you can create a new connector in a paused state by specifying the paused parameter in payloads.

June 2020link

We have implemented new Connector, Group, and Destination Management API endpoints for our REST API. You can now leverage the following new features:

• Create a Group
• Create a Destination
• Modify a Destination
• Reload a Connector Schema Config

We have expanded the current public API endpoint Create a Destination. Now, you can:

• control whether setup test are executed automatically by specifying the run_setup_tests parameter.
• create a Snowflake destination with password-based or key-based authentication types. Read our updated documentation about Snowflake destination config.

April 2020link

We have made changes to the re-sync connector table data endpoint. Now, if another data sync is in progress, we will try to complete it, and if it is unsuccessful the request will be declined and the HTTP 409 Conflict error will be returned.

You can now generate a new API secret from the account settings form if you think your current one was compromised. Read our REST API docs to learn how to regenerate your secret.

We have added Magento MySQL and Magento MySQL RDS to the list of connectors that can be created via our REST API.

March 2020link

We have implemented new Connector Management API endpoints for our REST API. You can now leverage the following new features:

• Modify a Connector Database Schema Config
• Modify a Connector Table Config
• Modify a Connector Column Config
• Run connector setup tests

We have expanded the current public API endpoints Create a Connector and Modify a Connector. Now, you can control whether setup test are executed automatically by specifying the run_setup_tests parameter. Read our REST API docs to learn how enable or disable automatic setup tests execution.

January 2020link

We have expanded the current public API Modify a Connector endpoint. Now you can enable or disable automatic connector sync by changing the 'schedule_type' parameter. Read our REST API docs to learn how to do that.

December 2019link

We have implemented new Connector Management API endpoints for our REST API. You can now leverage the following new features:

• Re-sync all historical data for a connector
• Sync connector data on demand (custom scheduling)
• Re-sync a specific table within a connector
• Retrieve a connector schema config
• Modify a connector schema config

September 2019link

We have disabled HTTP protocol support for our REST API module for both public and partner APIs. To access the Fivetran REST API, you must now use HTTPS protocol, which is much more secure.