> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Fivetran

> How to set up the Fivetran connector, plus the actions and events that are available.

![Fivetran](https://stackone-logos.com/api/fivetran/filled/svg)

Previewv1.3.0[See changelog](https://docs.stackone.com/connectors/fivetran/changelog.md)

[172 actions](#actions) · [16 events](#events) · 1 auth method

Data Integration
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/fivetran/guides/connector-profile/api-key.md)
>
> Uses a scoped API key that inherits RBAC permissions of the generating user. The API secret is shown only once at genera...

Optionally, configure receiving Events for Fivetran into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/fivetran/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/fivetran/guides/link-account/api-key.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

172 actions

ActionDescription

List Connection Certificates`fivetran_list_connection_certificates`

Retrieve all approved TLS certificates for a connection

Approve Connection Certificate`fivetran_approve_connection_certificate`

Approve a TLS certificate for a connection to enable secure connectivity

Get Connection Certificate`fivetran_get_connection_certificate`

Retrieve details of a specific approved certificate for a connection

Revoke Connection Certificate`fivetran_revoke_connection_certificate`

Revoke an approved TLS certificate from a connection

List Connection Fingerprints`fivetran_list_connection_fingerprints`

Retrieve all approved SSH fingerprints for a connection

Approve Connection Fingerprint`fivetran_approve_connection_fingerprint`

Approve an SSH fingerprint for a connection

Revoke Connection Fingerprint`fivetran_revoke_connection_fingerprint`

Revoke an approved SSH fingerprint from a connection

List Destination Certificates`fivetran_list_destination_certificates`

Retrieve all approved TLS certificates for a destination

Approve Destination Certificate`fivetran_approve_destination_certificate`

Approve a TLS certificate for a destination

Revoke Destination Certificate`fivetran_revoke_destination_certificate`

Revoke an approved TLS certificate from a destination

List Destination Fingerprints`fivetran_list_destination_fingerprints`

Retrieve all approved SSH fingerprints for a destination

Approve Destination Fingerprint`fivetran_approve_destination_fingerprint`

Approve an SSH fingerprint for a destination

Revoke Destination Fingerprint`fivetran_revoke_destination_fingerprint`

Revoke an approved SSH fingerprint from a destination

List All Connector SDK Packages`fivetran_list_connector_sdk_packages`

Returns a list of all Connector SDK packages in your Fivetran account

Retrieve Connector SDK Package Details`fivetran_get_connector_sdk_package`

Returns details for a specific Connector SDK package

Create Connector SDK Package`fivetran_create_connector_sdk_package`

Upload a new Connector SDK package to your Fivetran account

Update Connector SDK Package`fivetran_update_connector_sdk_package`

Update an existing Connector SDK package with new connector code

Download Connector SDK Package`fivetran_download_connector_sdk_package`

Download the connector code package file for a specific Connector SDK package

Delete Connector SDK Package`fivetran_delete_connector_sdk_package`

Permanently delete a Connector SDK package from your Fivetran account

List Connections`fivetran_list_connections`

Retrieve all connections (data pipelines) in the Fivetran account

Create Connection`fivetran_create_connection`

Create a new data connection (pipeline) within a destination group

Get Connection`fivetran_get_connection`

Retrieve detailed information about a specific connection by ID

Update Connection`fivetran_update_connection`

Modify a connection's configuration, sync schedule, or pause state

Delete Connection`fivetran_delete_connection`

Permanently remove a connection from the Fivetran account

Sync Connection Data`fivetran_sync_connection`

Manually trigger an incremental data sync for a connection

Re-sync Connection Data`fivetran_resync_connection`

Trigger a full historical re-sync of all connection data

Run Connection Setup Tests`fivetran_test_connection`

Execute setup validation tests to verify a connection's configuration

Get Connection State`fivetran_get_connection_state`

Retrieve the current state of a connection (only for Function and Connection SDK connectors)

Update Connection State`fivetran_update_connection_state`

Update the state of a connection (only for Function and Connection SDK connectors)

Get Connection Schema Config`fivetran_get_connection_schema`

Retrieve schema configuration for a connection including enabled tables and columns

Update Connection Schema Config`fivetran_update_connection_schema`

Enable or disable schemas, tables, and columns for a connection

Reload Connection Schema`fivetran_reload_connection_schema`

Reload and refresh the schema configuration from the source to detect new tables or columns

Generate Connect Card`fivetran_generate_connect_card`

Generate a Connect Card URI for embedding connector setup in an application

List Destinations`fivetran_list_destinations`

Retrieve all destinations in the Fivetran account

Create Destination`fivetran_create_destination`

Create a new destination (data warehouse or database) within a group

Get Destination`fivetran_get_destination`

Retrieve details of a specific destination by ID

Update Destination`fivetran_update_destination`

Modify a destination's configuration settings

Delete Destination`fivetran_delete_destination`

Permanently remove a destination from the Fivetran account

Run Destination Setup Tests`fivetran_test_destination`

Execute validation tests to verify a destination's configuration and connectivity

Webhook Verification`fivetran_webhook_test_event`

Acknowledges Fivetran's test\_event validation ping (and any unmatched/malformed payload) with a 200 — no event is emitte...

Sync Start Webhook`fivetran_webhook_sync_start`

Processes Fivetran sync\_start webhook events.

Sync End Webhook`fivetran_webhook_sync_end`

Processes Fivetran sync\_end webhook events.

Transformation Start Webhook`fivetran_webhook_transformation_start`

Processes Fivetran transformation\_start webhook events.

Transformation Succeeded Webhook`fivetran_webhook_transformation_succeeded`

Processes Fivetran transformation\_succeeded webhook events.

Transformation Failed Webhook`fivetran_webhook_transformation_failed`

Processes Fivetran transformation\_failed webhook events.

Connection Successful Webhook`fivetran_webhook_connection_successful`

Processes Fivetran connection\_successful webhook events.

Connection Failure Webhook`fivetran_webhook_connection_failure`

Processes Fivetran connection\_failure webhook events.

Create Connector Webhook`fivetran_webhook_create_connector`

Processes Fivetran create\_connector webhook events.

Pause Connector Webhook`fivetran_webhook_pause_connector`

Processes Fivetran pause\_connector webhook events.

Resume Connector Webhook`fivetran_webhook_resume_connector`

Processes Fivetran resume\_connector webhook events.

Edit Connector Webhook`fivetran_webhook_edit_connector`

Processes Fivetran edit\_connector webhook events.

Delete Connector Webhook`fivetran_webhook_delete_connector`

Processes Fivetran delete\_connector webhook events.

Force Update Connector Webhook`fivetran_webhook_force_update_connector`

Processes Fivetran force\_update\_connector webhook events.

Resync Connector Webhook`fivetran_webhook_resync_connector`

Processes Fivetran resync\_connector webhook events.

Resync Table Webhook`fivetran_webhook_resync_table`

Processes Fivetran resync\_table webhook events.

List Groups`fivetran_list_groups`

Retrieve all groups (destinations) in the Fivetran account

Create Group`fivetran_create_group`

Create a new group (destination) in the Fivetran account

Get Group`fivetran_get_group`

Retrieve details of a specific group by ID

Update Group`fivetran_update_group`

Modify a group's name or properties

Delete Group`fivetran_delete_group`

Permanently remove a group from the Fivetran account

List Group Users`fivetran_list_group_users`

Retrieve all users with access to a specific group

Add User To Group`fivetran_add_group_user`

Add an existing user to a group with a specified role

Remove User From Group`fivetran_remove_group_user`

Revoke a user's access to a specific group

List Group Connections`fivetran_list_group_connections`

Retrieve all connections within a specific group

Get Group SSH Key`fivetran_get_group_ssh_key`

Retrieve the SSH public key for a specific group

Get Group Service Account`fivetran_get_group_service_account`

Retrieve service account credentials for a specific group

Get Unified Credentials`fivetran_unified_get_me`

Return the connected Fivetran account identity and auth type mapped to the IAM unified credentials schema. Fivetran has...

IAM Auth Test`fivetran_auth_test`

Validate the current Fivetran API key + secret and return the raw, unmapped Fivetran /v1/account/info JSON (id, account\_...

List Unified Groups`fivetran_unified_list_groups`

List every Fivetran Team mapped to the IAM unified group schema, cursor-paginated up to 1000 per page. Fivetran Teams ar...

Get Unified Group`fivetran_unified_get_group`

Retrieve a single Fivetran Team by id, mapped to the IAM unified group schema. Optionally pass expand=\["users"] to inlin...

List Unified Organizations`fivetran_unified_list_organizations`

List the organizations available to the current Fivetran connection mapped to the IAM unified organization schema. Fivet...

Get Unified Organization`fivetran_unified_get_organization`

Retrieve the connected Fivetran account as the single organization record. Fivetran is single-tenant per API key — this...

List Unified Resource Types`fivetran_unified_list_resource_types`

Enumerate the resource\_type values accepted by unified\_list\_resource\_users on this connector. On Fivetran the supported...

List Unified Resource Users`fivetran_unified_list_resource_users`

List the users with access to a specific Fivetran destination (Group) or Team as IAM users, each annotated with their re...

List Unified Roles`fivetran_unified_list_roles`

List every role available in the connected Fivetran account (predefined and custom), mapped to the IAM unified role sche...

Get Unified Role`fivetran_unified_get_role`

Retrieve a single Fivetran role by its name (the Fivetran identifier). Fivetran has no per-role GET endpoint — implement...

List Unified Users`fivetran_unified_list_users`

List every user in the connected Fivetran account mapped to the IAM unified user schema, cursor-paginated up to 1000 per...

Get Unified User`fivetran_unified_get_user`

Retrieve a single Fivetran user by id, mapped to the IAM unified user schema. Optionally pass expand=\["groups"] to inlin...

List Hybrid Deployment Agents`fivetran_list_hybrid_deployment_agents`

Retrieve all hybrid deployment agents in the Fivetran account

Create Hybrid Deployment Agent`fivetran_create_hybrid_deployment_agent`

Create a new hybrid deployment agent for on-premises data processing

Get Hybrid Deployment Agent`fivetran_get_hybrid_deployment_agent`

Retrieve details of a specific hybrid deployment agent by ID

Regenerate Agent Authentication Keys`fivetran_regenerate_agent_auth_keys`

Regenerate authentication keys for a hybrid deployment agent

Reset Agent Credentials`fivetran_reset_agent_credentials`

Reset credentials for a hybrid deployment agent

Delete Hybrid Deployment Agent`fivetran_delete_hybrid_deployment_agent`

Permanently remove a hybrid deployment agent

List Log Services`fivetran_list_log_services`

Retrieve all configured external log service integrations

Create Log Service`fivetran_create_log_service`

Configure a new external log service integration for a group

Get Log Service`fivetran_get_log_service`

Retrieve details of a specific log service integration by ID

Update Log Service`fivetran_update_log_service`

Modify a log service integration's configuration

Test Log Service`fivetran_test_log_service`

Run validation tests for a log service integration

Delete Log Service`fivetran_delete_log_service`

Permanently remove a log service integration

Get Account Log Service`fivetran_get_account_log_service`

Retrieve the account-level external log service configuration

Create Account Log Service`fivetran_create_account_log_service`

Configure an account-level external log service integration

Update Account Log Service`fivetran_update_account_log_service`

Modify the account-level log service integration configuration

Delete Account Log Service`fivetran_delete_account_log_service`

Permanently remove the account-level log service integration

List Private Links`fivetran_list_private_links`

Retrieve all private link configurations in the Fivetran account

Create Private Link`fivetran_create_private_link`

Set up a new private network connection for Fivetran

Get Private Link`fivetran_get_private_link`

Retrieve details of a specific private link configuration by ID

Update Private Link`fivetran_update_private_link`

Modify a private link configuration

Delete Private Link`fivetran_delete_private_link`

Permanently remove a private link configuration

List Proxy Agents`fivetran_list_proxy_agents`

Retrieve all proxy agents in the Fivetran account

Create Proxy Agent`fivetran_create_proxy_agent`

Create a new proxy agent for network routing

Get Proxy Agent`fivetran_get_proxy_agent`

Retrieve details of a specific proxy agent by ID

List Proxy Agent Connections`fivetran_list_proxy_agent_connections`

Retrieve all connections routed through a specific proxy agent

Delete Proxy Agent`fivetran_delete_proxy_agent`

Permanently remove a proxy agent

Get Account Information`fivetran_get_account`

Retrieve account details associated with the current API credentials

List Connector Metadata`fivetran_list_connector_metadata`

Retrieve metadata about all connector types supported by Fivetran

Get Connector Metadata`fivetran_get_connector_metadata`

Retrieve configuration metadata for a specific connector type

List Roles`fivetran_list_roles`

Retrieve all predefined and custom roles in the Fivetran account

List System Keys`fivetran_list_system_keys`

Retrieve all system API keys in the Fivetran account

Create System Key`fivetran_create_system_key`

Generate a new system API key for programmatic access

Get System Key`fivetran_get_system_key`

Retrieve details of a specific system key by ID

Update System Key`fivetran_update_system_key`

Modify a system key's name or permission role

Rotate System Key`fivetran_rotate_system_key`

Generate a new secret for an existing system key without downtime

Delete System Key`fivetran_delete_system_key`

Permanently remove a system key and revoke its access

List Teams`fivetran_list_teams`

Retrieve all teams in the Fivetran account

Create Team`fivetran_create_team`

Create a new team for organizing users and managing permissions

Get Team`fivetran_get_team`

Retrieve details of a specific team by ID

Update Team`fivetran_update_team`

Modify a team's name, description, or account-level role

Delete Team`fivetran_delete_team`

Permanently remove a team from the Fivetran account

Delete Team Account Role`fivetran_delete_team_account_role`

Revoke a team's account-level role assignment

List Team Users`fivetran_list_team_users`

Retrieve all users that are members of a specific team

Get Team User Membership`fivetran_get_team_user`

Retrieve details of a user's membership in a specific team

Add User To Team`fivetran_add_team_user`

Add a user to a team with a specified role

Update Team User Membership`fivetran_update_team_user`

Modify a user's role within a specific team

Remove User From Team`fivetran_delete_team_user`

Remove a user from a specific team

List Team Connection Memberships`fivetran_list_team_connections`

Retrieve all connections accessible by a specific team

Get Team Connection Membership`fivetran_get_team_connection`

Retrieve a team's access details for a specific connection

Add Team Connection Membership`fivetran_add_team_connection`

Grant a team access to a specific connection

Update Team Connection Membership`fivetran_update_team_connection`

Modify a team's role for a specific connection

Delete Team Connection Membership`fivetran_delete_team_connection`

Revoke a team's access to a specific connection

List Team Group Memberships`fivetran_list_team_groups`

Retrieve all groups accessible by a specific team

Get Team Group Membership`fivetran_get_team_group`

Retrieve a team's membership details for a specific group

Add Team Group Membership`fivetran_add_team_group`

Associate a team with a group, granting group-level access

Update Team Group Membership`fivetran_update_team_group`

Modify a team's role within a specific group

Delete Team Group Membership`fivetran_delete_team_group`

Remove a team's membership from a specific group

List Transformations`fivetran_list_transformations`

Retrieve all data transformations in the Fivetran account

Create Transformation`fivetran_create_transformation`

Create a new data transformation in Fivetran

Get Transformation`fivetran_get_transformation`

Retrieve details of a specific transformation by ID

Update Transformation`fivetran_update_transformation`

Modify a transformation's configuration or schedule

Run Transformation`fivetran_run_transformation`

Manually trigger a transformation run

Cancel Transformation`fivetran_cancel_transformation`

Stop a currently running transformation

Delete Transformation`fivetran_delete_transformation`

Permanently remove a transformation from the account

List Transformation Packages`fivetran_list_transformation_packages`

Retrieve available Quickstart transformation packages

List Transformation Projects`fivetran_list_transformation_projects`

Retrieve all transformation projects in the account

Create Transformation Project`fivetran_create_transformation_project`

Create a new transformation project (e.g., a dbt project)

Get Transformation Project`fivetran_get_transformation_project`

Retrieve details of a specific transformation project by ID

Update Transformation Project`fivetran_update_transformation_project`

Modify a transformation project's configuration

Test Transformation Project`fivetran_test_transformation_project`

Run validation tests for a transformation project configuration

Delete Transformation Project`fivetran_delete_transformation_project`

Permanently remove a transformation project

List Users`fivetran_list_users`

Returns a list of all users within your Fivetran account

Invite A User`fivetran_invite_user`

Invites a new user to your Fivetran account

Retrieve A User Details`fivetran_get_user`

Returns a user object if a valid identifier was provided

Update A User`fivetran_update_user`

Updates information for an existing user within your Fivetran account

Delete A User`fivetran_delete_user`

Deletes a user from your Fivetran account

Delete Account Role`fivetran_delete_user_account_role`

Removes a user's role from an account; the user remains a member of the account

List All Connection Memberships`fivetran_list_user_connection_memberships`

Returns all connection memberships for a user within your Fivetran account

Retrieve Connection Membership`fivetran_get_user_connection_membership`

Returns the details of a user's membership in a connection

Add A Connection Membership`fivetran_add_user_connection_membership`

Adds a connection membership for a user

Update Connection Membership`fivetran_update_user_connection_membership`

Updates user membership in a connection

Delete Connection Membership`fivetran_delete_user_connection_membership`

Removes user membership in a connection

List All Group Memberships`fivetran_list_user_group_memberships`

Returns the membership details for all groups a user belongs to

Retrieve Group Membership Details`fivetran_get_user_group_membership`

Returns details of a user membership in a group

Add Group Membership`fivetran_add_user_group_membership`

Adds a user membership in a group

Update Group Membership`fivetran_update_user_group_membership`

Updates user group membership

Delete Group Membership`fivetran_delete_user_group_membership`

Removes user from a group

List Webhooks`fivetran_list_webhooks`

Retrieve all configured webhooks in the Fivetran account

Create Account Webhook`fivetran_create_account_webhook`

Create a new webhook for the current account

Create Group Webhook`fivetran_create_group_webhook`

Create a new webhook for a specific group

Get Webhook`fivetran_get_webhook`

Retrieve details of a specific webhook by ID

Update Webhook`fivetran_update_webhook`

Update an existing webhook's URL, events, active state, or secret

Test Webhook`fivetran_test_webhook`

Send a test event to a webhook to verify its configuration

Delete Webhook`fivetran_delete_webhook`

Delete an existing webhook by ID

## Events

Tags

Select all
|
Clear

Connections

Syncs

Transformations

Webhooks

No tags found

16 events

EventDescriptionTags

Webhook Verification`fivetran_webhook_test_event`

Acknowledges Fivetran's test\_event validation ping (and any unmatched/malformed payload) with a 200 — no event is emitte...

Webhooks

Sync Start Webhook`fivetran_webhook_sync_start`

Processes Fivetran sync\_start webhook events.

SyncsWebhooks

Sync End Webhook`fivetran_webhook_sync_end`

Processes Fivetran sync\_end webhook events.

SyncsWebhooks

Transformation Start Webhook`fivetran_webhook_transformation_start`

Processes Fivetran transformation\_start webhook events.

TransformationsWebhooks

Transformation Succeeded Webhook`fivetran_webhook_transformation_succeeded`

Processes Fivetran transformation\_succeeded webhook events.

TransformationsWebhooks

Transformation Failed Webhook`fivetran_webhook_transformation_failed`

Processes Fivetran transformation\_failed webhook events.

TransformationsWebhooks

Connection Successful Webhook`fivetran_webhook_connection_successful`

Processes Fivetran connection\_successful webhook events.

ConnectionsWebhooks

Connection Failure Webhook`fivetran_webhook_connection_failure`

Processes Fivetran connection\_failure webhook events.

ConnectionsWebhooks

Create Connector Webhook`fivetran_webhook_create_connector`

Processes Fivetran create\_connector webhook events.

ConnectionsWebhooks

Pause Connector Webhook`fivetran_webhook_pause_connector`

Processes Fivetran pause\_connector webhook events.

ConnectionsWebhooks

Resume Connector Webhook`fivetran_webhook_resume_connector`

Processes Fivetran resume\_connector webhook events.

ConnectionsWebhooks

Edit Connector Webhook`fivetran_webhook_edit_connector`

Processes Fivetran edit\_connector webhook events.

ConnectionsWebhooks

Delete Connector Webhook`fivetran_webhook_delete_connector`

Processes Fivetran delete\_connector webhook events.

ConnectionsWebhooks

Force Update Connector Webhook`fivetran_webhook_force_update_connector`

Processes Fivetran force\_update\_connector webhook events.

ConnectionsWebhooks

Resync Connector Webhook`fivetran_webhook_resync_connector`

Processes Fivetran resync\_connector webhook events.

ConnectionsWebhooks

Resync Table Webhook`fivetran_webhook_resync_table`

Processes Fivetran resync\_table webhook events.

ConnectionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.