Fivetran

Fivetran is a managed data movement platform that replicates data from SaaS apps, databases, and logs into warehouses and lakehouses such as Databricks, Snowflake, and BigQuery.

With the Fivetran block, you can:

  • Manage connections: List, read, create, update, pause, resume, and delete connections, look up the setup fields a connector type takes (such as Okta), and generate Connect Card links so source owners can authorize a connection themselves.
  • Run and repair syncs: Start a sync on demand, re-sync a whole connection or specific tables, run setup tests, reload the schema, and change which schemas and tables a connection syncs and how it handles new ones.
  • Monitor pipelines: Read sync history with per-stage data volumes, active warnings, schema configs, and each connection's setup, sync, and update state.
  • Work with destinations and transformations: Create and inspect groups and destinations such as Databricks, run destination setup tests, and list, run, or cancel transformations.
  • Review the account: Read account details, list users and service accounts, and look up the connector types you can create.
  • React to events: Start workflows when syncs start or end, connections succeed, fail, or change, tables are re-synced, or transformations start, succeed, or fail.

To connect, click your username in Fivetran, then API Key > Generate API key. In the block, choose Add API key under Fivetran Account and paste the key and secret. Sim checks them against your Fivetran account, stores them encrypted as a reusable workspace credential, and fills the Connection, Group, and Destination dropdowns from that account. The key acts with your Fivetran permissions.

Triggers take the API key and secret directly, register a webhook in Fivetran when you deploy the workflow (for the whole account or one group), and verify every delivery against a signing secret Sim generates for that webhook. The webhook is removed when you delete the trigger and redeploy.

In Sim, the Fivetran block lets your agents triage failed syncs as they happen, keep security log pipelines into your SIEM from going stale, run dbt transformations after loads finish, and report on pipeline health and account access.

Usage Instructions

Integrate Fivetran into the workflow. List, create, update, pause, resume, and delete connections, trigger syncs and historical re-syncs, read sync history, warnings, and schema configs, enable or disable schemas and tables, run setup tests, generate Connect Card links, look up connector setup fields, create and inspect groups and destinations, run and cancel transformations, review users, and react to sync, connection, and transformation webhooks.

Actions

Fivetran List Connections

List Fivetran connections with their sync state, schedule, and last success or failure, optionally filtered by group or schema name.

Input

ParameterTypeRequiredDescription
groupIdstringNoOnly return connections in this group
schemastringNoOnly return the connection with this exact schema name
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
connectionsarrayConnections
↳ idstringConnection ID
↳ groupIdstringDestination group ID
↳ servicestringConnector type, e.g. okta
↳ serviceVersionnumberConnector type version
↳ schemastringConnection name, also the destination schema name
↳ pausedbooleanWhether the connection is paused
↳ pauseAfterTrialbooleanWhether the connection pauses when the free trial ends
↳ connectedBystringID of the user who created the connection
↳ createdAtstringWhen the connection was created
↳ succeededAtstringLast successful sync time
↳ failedAtstringLast failed sync time
↳ syncFrequencynumberSync frequency in minutes
↳ scheduleTypestringScheduling mode (auto or manual)
↳ dailySyncTimestringDaily sync start time (HH:MM) for 24-hour frequency
↳ dataDelaySensitivitystringData delay notification level (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY)
↳ dataDelayThresholdnumberCustom data delay threshold in minutes
↳ networkingMethodstringNetworking method, e.g. Directly or SshTunnel
↳ privateLinkIdstringPrivate link ID
↳ proxyAgentIdstringProxy agent ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ dataChecksbooleanWhether automated data validation is enabled
↳ destinationSchemaNamesstringDestination schema naming (FIVETRAN_NAMING or SOURCE_NAMING)
↳ statusobjectCurrent connection state
↳ setupStatestringSetup state (incomplete, connected, broken)
↳ syncStatestringSync state (scheduled, syncing, paused, rescheduled)
↳ updateStatestringData update state (on_schedule, delayed)
↳ isHistoricalSyncbooleanWhether a historical re-sync is pending or running
↳ schemaStatusstringSchema status
↳ rescheduledForstringNext sync attempt when the sync is rescheduled
↳ tasksarrayTasks that need action
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ warningsarrayActive warnings
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ scheduleobjectSync schedule configuration
↳ scheduleTypestringSchedule type (TIME_OF_DAY, INTERVAL, CRON, MANUAL)
↳ intervalnumberInterval in minutes
↳ cronstringCron expression
↳ daysOfWeekarrayDays the connection can sync
↳ timeOfDaystringTime of day (HH:MM)
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
↳ configjsonConnector-specific setup configuration
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Connection

Get a Fivetran connection, including its setup, sync, and update state, open tasks and warnings, and schedule.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection

Output

ParameterTypeDescription
connectionobjectThe connection
↳ idstringConnection ID
↳ groupIdstringDestination group ID
↳ servicestringConnector type, e.g. okta
↳ serviceVersionnumberConnector type version
↳ schemastringConnection name, also the destination schema name
↳ pausedbooleanWhether the connection is paused
↳ pauseAfterTrialbooleanWhether the connection pauses when the free trial ends
↳ connectedBystringID of the user who created the connection
↳ createdAtstringWhen the connection was created
↳ succeededAtstringLast successful sync time
↳ failedAtstringLast failed sync time
↳ syncFrequencynumberSync frequency in minutes
↳ scheduleTypestringScheduling mode (auto or manual)
↳ dailySyncTimestringDaily sync start time (HH:MM) for 24-hour frequency
↳ dataDelaySensitivitystringData delay notification level (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY)
↳ dataDelayThresholdnumberCustom data delay threshold in minutes
↳ networkingMethodstringNetworking method, e.g. Directly or SshTunnel
↳ privateLinkIdstringPrivate link ID
↳ proxyAgentIdstringProxy agent ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ dataChecksbooleanWhether automated data validation is enabled
↳ destinationSchemaNamesstringDestination schema naming (FIVETRAN_NAMING or SOURCE_NAMING)
↳ statusobjectCurrent connection state
↳ setupStatestringSetup state (incomplete, connected, broken)
↳ syncStatestringSync state (scheduled, syncing, paused, rescheduled)
↳ updateStatestringData update state (on_schedule, delayed)
↳ isHistoricalSyncbooleanWhether a historical re-sync is pending or running
↳ schemaStatusstringSchema status
↳ rescheduledForstringNext sync attempt when the sync is rescheduled
↳ tasksarrayTasks that need action
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ warningsarrayActive warnings
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ scheduleobjectSync schedule configuration
↳ scheduleTypestringSchedule type (TIME_OF_DAY, INTERVAL, CRON, MANUAL)
↳ intervalnumberInterval in minutes
↳ cronstringCron expression
↳ daysOfWeekarrayDays the connection can sync
↳ timeOfDaystringTime of day (HH:MM)
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
↳ configjsonConnector-specific setup configuration

Fivetran Create Connection

Create a Fivetran connection in a group. The config object holds the connector-specific settings and the destination naming: schema for most connectors, schema_prefix for databases, or schema and table for file connectors.

Input

ParameterTypeRequiredDescription
groupIdstringYesID of the destination group to create the connection in
servicestringYesConnector type ID, e.g. okta or google_sheets (see List Connector Types)
configjsonYesConnector-specific setup configuration, including the destination name: schema (most connectors), schema_prefix (databases), or schema and table (file connectors), e.g. {"schema": "okta", "domain": "acme", "api_token": "..."}
authjsonNoConnector-specific authorization settings, for connectors that take them
pausedbooleanNoCreate the connection paused
syncFrequencynumberNoSync frequency in minutes (1, 5, 15, 30, 60, 120, 180, 360, 480, 720, or 1440)
scheduleTypestringNoauto lets Fivetran schedule syncs; manual runs syncs only on request
dailySyncTimestringNoDaily sync start time (HH:MM) when the sync frequency is 1440
dataDelaySensitivitystringNoData delay notification level: LOW, NORMAL, HIGH, CUSTOM, or SYNC_FREQUENCY
dataDelayThresholdnumberNoCustom data delay threshold in minutes, used with CUSTOM sensitivity
destinationSchemaNamesstringNoDestination schema naming: FIVETRAN_NAMING or SOURCE_NAMING
pauseAfterTrialbooleanNoPause the connection when its free trial ends
runSetupTestsbooleanNoRun the setup tests after creating the connection
trustCertificatesbooleanNoAutomatically trust the source certificate during setup tests (default false)
trustFingerprintsbooleanNoAutomatically trust the SSH fingerprint during setup tests (default false)

Output

ParameterTypeDescription
connectionobjectThe created connection, with setup test results when they ran
↳ idstringConnection ID
↳ groupIdstringDestination group ID
↳ servicestringConnector type, e.g. okta
↳ serviceVersionnumberConnector type version
↳ schemastringConnection name, also the destination schema name
↳ pausedbooleanWhether the connection is paused
↳ pauseAfterTrialbooleanWhether the connection pauses when the free trial ends
↳ connectedBystringID of the user who created the connection
↳ createdAtstringWhen the connection was created
↳ succeededAtstringLast successful sync time
↳ failedAtstringLast failed sync time
↳ syncFrequencynumberSync frequency in minutes
↳ scheduleTypestringScheduling mode (auto or manual)
↳ dailySyncTimestringDaily sync start time (HH:MM) for 24-hour frequency
↳ dataDelaySensitivitystringData delay notification level (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY)
↳ dataDelayThresholdnumberCustom data delay threshold in minutes
↳ networkingMethodstringNetworking method, e.g. Directly or SshTunnel
↳ privateLinkIdstringPrivate link ID
↳ proxyAgentIdstringProxy agent ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ dataChecksbooleanWhether automated data validation is enabled
↳ destinationSchemaNamesstringDestination schema naming (FIVETRAN_NAMING or SOURCE_NAMING)
↳ statusobjectCurrent connection state
↳ setupStatestringSetup state (incomplete, connected, broken)
↳ syncStatestringSync state (scheduled, syncing, paused, rescheduled)
↳ updateStatestringData update state (on_schedule, delayed)
↳ isHistoricalSyncbooleanWhether a historical re-sync is pending or running
↳ schemaStatusstringSchema status
↳ rescheduledForstringNext sync attempt when the sync is rescheduled
↳ tasksarrayTasks that need action
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ warningsarrayActive warnings
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ scheduleobjectSync schedule configuration
↳ scheduleTypestringSchedule type (TIME_OF_DAY, INTERVAL, CRON, MANUAL)
↳ intervalnumberInterval in minutes
↳ cronstringCron expression
↳ daysOfWeekarrayDays the connection can sync
↳ timeOfDaystringTime of day (HH:MM)
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
↳ configjsonConnector-specific setup configuration

Fivetran Update Connection

Update a Fivetran connection: pause or resume it, change its sync frequency or schedule, or update its configuration.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
pausedbooleanNotrue pauses the connection, false resumes it
syncFrequencynumberNoSync frequency in minutes (1, 5, 15, 30, 60, 120, 180, 360, 480, 720, or 1440)
scheduleTypestringNoauto lets Fivetran schedule syncs; manual runs syncs only on request
dailySyncTimestringNoDaily sync start time (HH:MM) when the sync frequency is 1440
dataDelaySensitivitystringNoData delay notification level: LOW, NORMAL, HIGH, CUSTOM, or SYNC_FREQUENCY
dataDelayThresholdnumberNoCustom data delay threshold in minutes, used with CUSTOM sensitivity
pauseAfterTrialbooleanNoPause the connection when its free trial ends
isHistoricalSyncbooleanNotrue triggers a re-sync of all historical data
configjsonNoConnector-specific configuration fields to change
authjsonNoConnector-specific authorization settings to change
runSetupTestsbooleanNoRun the setup tests after the update
trustCertificatesbooleanNoAutomatically trust the source certificate during setup tests (default false)
trustFingerprintsbooleanNoAutomatically trust the SSH fingerprint during setup tests (default false)

Output

ParameterTypeDescription
connectionobjectThe updated connection
↳ idstringConnection ID
↳ groupIdstringDestination group ID
↳ servicestringConnector type, e.g. okta
↳ serviceVersionnumberConnector type version
↳ schemastringConnection name, also the destination schema name
↳ pausedbooleanWhether the connection is paused
↳ pauseAfterTrialbooleanWhether the connection pauses when the free trial ends
↳ connectedBystringID of the user who created the connection
↳ createdAtstringWhen the connection was created
↳ succeededAtstringLast successful sync time
↳ failedAtstringLast failed sync time
↳ syncFrequencynumberSync frequency in minutes
↳ scheduleTypestringScheduling mode (auto or manual)
↳ dailySyncTimestringDaily sync start time (HH:MM) for 24-hour frequency
↳ dataDelaySensitivitystringData delay notification level (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY)
↳ dataDelayThresholdnumberCustom data delay threshold in minutes
↳ networkingMethodstringNetworking method, e.g. Directly or SshTunnel
↳ privateLinkIdstringPrivate link ID
↳ proxyAgentIdstringProxy agent ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ dataChecksbooleanWhether automated data validation is enabled
↳ destinationSchemaNamesstringDestination schema naming (FIVETRAN_NAMING or SOURCE_NAMING)
↳ statusobjectCurrent connection state
↳ setupStatestringSetup state (incomplete, connected, broken)
↳ syncStatestringSync state (scheduled, syncing, paused, rescheduled)
↳ updateStatestringData update state (on_schedule, delayed)
↳ isHistoricalSyncbooleanWhether a historical re-sync is pending or running
↳ schemaStatusstringSchema status
↳ rescheduledForstringNext sync attempt when the sync is rescheduled
↳ tasksarrayTasks that need action
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ warningsarrayActive warnings
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ scheduleobjectSync schedule configuration
↳ scheduleTypestringSchedule type (TIME_OF_DAY, INTERVAL, CRON, MANUAL)
↳ intervalnumberInterval in minutes
↳ cronstringCron expression
↳ daysOfWeekarrayDays the connection can sync
↳ timeOfDaystringTime of day (HH:MM)
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
↳ configjsonConnector-specific setup configuration

Fivetran Delete Connection

Delete a Fivetran connection. This cannot be undone.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection

Output

ParameterTypeDescription
codestringFivetran response code, e.g. Success
messagestringFivetran response message

Fivetran Sync Connection

Start an incremental sync of a Fivetran connection now, without changing its schedule.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
forcebooleanNoStop a sync that is already running and start again. By default a running sync is left alone.

Output

ParameterTypeDescription
resultstringSync start result (STARTED, PAUSED, INCOMPLETE, ALREADY_RUNNING, NOT_STARTED)
messagestringFivetran response message

Fivetran Re-sync Connection

Run a full historical re-sync of a Fivetran connection, or only of the tables listed in scope. Fivetran returns 409 if a running sync cannot finish first.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
scopejsonNoTables to re-sync, as a map of schema name to table names, e.g. {"public": ["users", "orders"]}. Omit to re-sync every table.

Output

ParameterTypeDescription
codestringFivetran response code, e.g. Success
messagestringFivetran response message

Fivetran Re-sync Tables

Run a historical re-sync of specific tables in a Fivetran connection without changing its schedule.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
tablesjsonYesTables to re-sync, as a map of schema name to table names, e.g. {"okta": ["system_log", "user"]}

Output

ParameterTypeDescription
codestringFivetran response code, e.g. Success
messagestringFivetran response message

Fivetran Run Connection Setup Tests

Run the setup tests of a Fivetran connection without changing its configuration, and return each test result.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
trustCertificatesbooleanNoAutomatically trust the source certificate during setup tests (default false)
trustFingerprintsbooleanNoAutomatically trust the SSH fingerprint during setup tests (default false)

Output

ParameterTypeDescription
connectionobjectThe connection with its setup test results in setupTests
↳ idstringConnection ID
↳ groupIdstringDestination group ID
↳ servicestringConnector type, e.g. okta
↳ serviceVersionnumberConnector type version
↳ schemastringConnection name, also the destination schema name
↳ pausedbooleanWhether the connection is paused
↳ pauseAfterTrialbooleanWhether the connection pauses when the free trial ends
↳ connectedBystringID of the user who created the connection
↳ createdAtstringWhen the connection was created
↳ succeededAtstringLast successful sync time
↳ failedAtstringLast failed sync time
↳ syncFrequencynumberSync frequency in minutes
↳ scheduleTypestringScheduling mode (auto or manual)
↳ dailySyncTimestringDaily sync start time (HH:MM) for 24-hour frequency
↳ dataDelaySensitivitystringData delay notification level (LOW, NORMAL, HIGH, CUSTOM, SYNC_FREQUENCY)
↳ dataDelayThresholdnumberCustom data delay threshold in minutes
↳ networkingMethodstringNetworking method, e.g. Directly or SshTunnel
↳ privateLinkIdstringPrivate link ID
↳ proxyAgentIdstringProxy agent ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ dataChecksbooleanWhether automated data validation is enabled
↳ destinationSchemaNamesstringDestination schema naming (FIVETRAN_NAMING or SOURCE_NAMING)
↳ statusobjectCurrent connection state
↳ setupStatestringSetup state (incomplete, connected, broken)
↳ syncStatestringSync state (scheduled, syncing, paused, rescheduled)
↳ updateStatestringData update state (on_schedule, delayed)
↳ isHistoricalSyncbooleanWhether a historical re-sync is pending or running
↳ schemaStatusstringSchema status
↳ rescheduledForstringNext sync attempt when the sync is rescheduled
↳ tasksarrayTasks that need action
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ warningsarrayActive warnings
↳ codestringMachine-readable condition code
↳ messagestringHuman-readable label
↳ detailsstringAdditional context
↳ scheduleobjectSync schedule configuration
↳ scheduleTypestringSchedule type (TIME_OF_DAY, INTERVAL, CRON, MANUAL)
↳ intervalnumberInterval in minutes
↳ cronstringCron expression
↳ daysOfWeekarrayDays the connection can sync
↳ timeOfDaystringTime of day (HH:MM)
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
↳ configjsonConnector-specific setup configuration

Fivetran Get Sync History

List the recent syncs of a Fivetran connection with their outcome, failure reason, and data volume per stage. The time window is at most 7 days and defaults to the last hour.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
startTimestringNoStart of the time window, ISO 8601 (e.g. 2026-01-01T00:00:00Z)
endTimestringNoEnd of the time window, ISO 8601 (e.g. 2026-01-01T01:00:00Z)
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
syncsarraySyncs in the time window
↳ syncIdstringSync ID
↳ statusstringOutcome (COMPLETED, FAILURE, CANCELED, INCOMPLETE, RESCHEDULED, PAUSED)
↳ startstringWhen the sync started
↳ endstringWhen the sync finished
↳ reasonstringFailure reason
↳ extractVolumeMbnumberData extracted from the source, in MB
↳ processVolumeMbnumberData processed, in MB
↳ loadVolumeMbnumberData loaded into the destination, in MB
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Connection Warnings

List the active warnings on a Fivetran connection, grouped by destination table.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection

Output

ParameterTypeDescription
warningGroupsarrayWarnings grouped by destination table
↳ schemastringDestination schema; null when the warning is not table-specific
↳ tablestringDestination table; null when the warning is not table-specific
↳ warningsarrayWarnings on the table
↳ codestringWarning code
↳ messagestringWarning label
↳ errorMessagestringAdditional error details
↳ createdAtstringWhen the warning was raised

Fivetran Get Connection Schema Config

Get the schemas, tables, and columns a Fivetran connection syncs, and whether each is enabled.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection

Output

ParameterTypeDescription
schemasjsonSchemas keyed by source schema name, each with name_in_destination, enabled, and tables keyed by table name (name_in_destination, enabled, sync_mode, columns)
enableNewByDefaultbooleanWhether new schemas, tables, and columns are enabled by default
schemaChangeHandlingstringSchema change handling (ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL)
rowFilteringSupportedbooleanWhether row filtering is available for the connection

Fivetran Reload Connection Schema

Reload the schema config of a Fivetran connection from its source to pick up new schemas, tables, and columns. Large sources can take a long time.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
excludeModestringNoPRESERVE (default) keeps the enabled state of every schema and table; EXCLUDE sets schemas and tables as disabled when the config is reloaded

Output

ParameterTypeDescription
schemasjsonSchemas keyed by source schema name, each with name_in_destination, enabled, and tables keyed by table name (name_in_destination, enabled, sync_mode, columns)
enableNewByDefaultbooleanWhether new schemas, tables, and columns are enabled by default
schemaChangeHandlingstringSchema change handling (ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL)
rowFilteringSupportedbooleanWhether row filtering is available for the connection

Fivetran Update Connection Table

Enable or disable syncing of one table in a Fivetran connection, and optionally change its sync mode.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
schemaNamestringYesSchema name as stored in the connection schema config (case-sensitive)
tableNamestringYesTable name as stored in the connection schema config (case-sensitive)
enabledbooleanYesWhether the table syncs to the destination
syncModestringNoSync mode: SOFT_DELETE, HISTORY, or LIVE (only for connectors that support switching)

Output

ParameterTypeDescription
schemasjsonSchemas keyed by source schema name, each with name_in_destination, enabled, and tables keyed by table name (name_in_destination, enabled, sync_mode, columns)
enableNewByDefaultbooleanWhether new schemas, tables, and columns are enabled by default
schemaChangeHandlingstringSchema change handling (ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL)
rowFilteringSupportedbooleanWhether row filtering is available for the connection

Fivetran Create Connect Card

Generate a Connect Card link that lets someone authorize and finish setting up a Fivetran connection in a Fivetran-hosted form.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
redirectUristringYesHTTPS URL to send the user to after they finish setup
hideSetupGuidebooleanNoHide the embedded setup guide
allFieldsbooleanNoShow fields that are hidden by default

Output

ParameterTypeDescription
connectionIdstringConnection ID
uristringConnect Card URL to send the user to; it embeds a short-lived token
tokenstringShort-lived Connect Card token
redirectUristringWhere the user is sent after setup

Fivetran List Groups

List the groups in the Fivetran account. Each group pairs with one destination, so the group ID is also the destination ID.

Input

ParameterTypeRequiredDescription
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
groupsarrayGroups in the account
↳ idstringGroup ID
↳ namestringGroup name
↳ createdAtstringWhen the group was created
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Group

Get a Fivetran group by ID.

Input

ParameterTypeRequiredDescription
groupIdstringYesID of the group

Output

ParameterTypeDescription
groupobjectThe group
↳ idstringGroup ID
↳ namestringGroup name
↳ createdAtstringWhen the group was created

Fivetran List Destinations

List the destinations in the Fivetran account, such as Databricks or Snowflake, with their region and setup status.

Input

ParameterTypeRequiredDescription
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
destinationsarrayDestinations
↳ idstringDestination ID
↳ groupIdstringGroup ID
↳ servicestringDestination type, e.g. databricks
↳ regionstringData processing region
↳ timeZoneOffsetstringUTC offset used for sync scheduling
↳ setupStatusstringSetup status (INCOMPLETE, CONNECTED, BROKEN)
↳ daylightSavingTimeEnabledbooleanWhether the offset shifts with daylight saving time
↳ networkingMethodstringNetworking method
↳ privateLinkIdstringPrivate link ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ proxyAgentIdstringProxy agent ID
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Destination

Get a Fivetran destination with its region, time zone, and setup status.

Input

ParameterTypeRequiredDescription
destinationIdstringYesID of the destination (the same as its group ID)

Output

ParameterTypeDescription
destinationobjectThe destination
↳ idstringDestination ID
↳ groupIdstringGroup ID
↳ servicestringDestination type, e.g. databricks
↳ regionstringData processing region
↳ timeZoneOffsetstringUTC offset used for sync scheduling
↳ setupStatusstringSetup status (INCOMPLETE, CONNECTED, BROKEN)
↳ daylightSavingTimeEnabledbooleanWhether the offset shifts with daylight saving time
↳ networkingMethodstringNetworking method
↳ privateLinkIdstringPrivate link ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ proxyAgentIdstringProxy agent ID
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details

Fivetran Run Destination Setup Tests

Run the setup tests of a Fivetran destination, such as a Databricks workspace, and return each test result.

Input

ParameterTypeRequiredDescription
destinationIdstringYesID of the destination (the same as its group ID)
trustCertificatesbooleanNoAutomatically trust the source certificate during setup tests (default false)
trustFingerprintsbooleanNoAutomatically trust the SSH fingerprint during setup tests (default false)

Output

ParameterTypeDescription
destinationobjectThe destination with its setup test results in setupTests
↳ idstringDestination ID
↳ groupIdstringGroup ID
↳ servicestringDestination type, e.g. databricks
↳ regionstringData processing region
↳ timeZoneOffsetstringUTC offset used for sync scheduling
↳ setupStatusstringSetup status (INCOMPLETE, CONNECTED, BROKEN)
↳ daylightSavingTimeEnabledbooleanWhether the offset shifts with daylight saving time
↳ networkingMethodstringNetworking method
↳ privateLinkIdstringPrivate link ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ proxyAgentIdstringProxy agent ID
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details

Fivetran List Transformations

List Fivetran transformations (dbt Core and Quickstart) with their status, schedule, and last run times.

Input

ParameterTypeRequiredDescription
groupIdstringNoOnly return transformations in this group
projectIdstringNoOnly return transformations in this dbt project
transformationTypestringNoOnly return this type: DBT_CORE or QUICKSTART
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
transformationsarrayTransformations
↳ idstringTransformation ID
↳ typestringType (DBT_CORE, QUICKSTART)
↳ statusstringStatus (NEW, SCHEDULING, RUNNING, TERMINATING, SUCCEEDED, FAILED, BLOCKED, CANCELED, PARTIALLY_SUCCEEDED)
↳ pausedbooleanWhether the transformation is paused
↳ createdAtstringWhen it was created
↳ createdByIdstringID of the creating user or key
↳ lastStartedAtstringLast run start time
↳ lastEndedAtstringLast run end time
↳ outputModelNamesarrayOutput model names
↳ scheduleobjectTransformation schedule
↳ scheduleTypestringSchedule type (INTEGRATED, TIME_OF_DAY, INTERVAL, CRON)
↳ intervalnumberInterval in minutes
↳ cronarrayCron expressions
↳ daysOfWeekarrayDays of the week
↳ timeOfDaystringTime of day (HH:MM)
↳ connectionIdsarrayConnections an integrated schedule depends on
↳ transformationIdsarrayTransformations used for integrated scheduling
↳ smartSyncingbooleanWhether Smart Syncing is enabled
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Transformation

Get a Fivetran transformation with its status, schedule, and output models.

Input

ParameterTypeRequiredDescription
transformationIdstringYesID of the transformation

Output

ParameterTypeDescription
transformationobjectThe transformation
↳ idstringTransformation ID
↳ typestringType (DBT_CORE, QUICKSTART)
↳ statusstringStatus (NEW, SCHEDULING, RUNNING, TERMINATING, SUCCEEDED, FAILED, BLOCKED, CANCELED, PARTIALLY_SUCCEEDED)
↳ pausedbooleanWhether the transformation is paused
↳ createdAtstringWhen it was created
↳ createdByIdstringID of the creating user or key
↳ lastStartedAtstringLast run start time
↳ lastEndedAtstringLast run end time
↳ outputModelNamesarrayOutput model names
↳ scheduleobjectTransformation schedule
↳ scheduleTypestringSchedule type (INTEGRATED, TIME_OF_DAY, INTERVAL, CRON)
↳ intervalnumberInterval in minutes
↳ cronarrayCron expressions
↳ daysOfWeekarrayDays of the week
↳ timeOfDaystringTime of day (HH:MM)
↳ connectionIdsarrayConnections an integrated schedule depends on
↳ transformationIdsarrayTransformations used for integrated scheduling
↳ smartSyncingbooleanWhether Smart Syncing is enabled

Fivetran Run Transformation

Start a run of a Fivetran transformation now.

Input

ParameterTypeRequiredDescription
transformationIdstringYesID of the transformation
fullRefreshbooleanNoRebuild incremental models from scratch (dbt --full-refresh)

Output

ParameterTypeDescription
codestringFivetran response code, e.g. Success
messagestringFivetran response message

Fivetran Cancel Transformation

Cancel a running Fivetran transformation.

Input

ParameterTypeRequiredDescription
transformationIdstringYesID of the transformation

Output

ParameterTypeDescription
codestringFivetran response code, e.g. Success
messagestringFivetran response message

Fivetran Get Account Info

Get the Fivetran account and the user or system key that the API key belongs to.

Input

ParameterTypeRequiredDescription

Output

ParameterTypeDescription
accountIdstringFivetran account ID
accountNamestringAccount name
userIdstringUser ID, returned when a user API key is used
systemKeyIdstringSystem key ID, returned when a system key is used

Fivetran List Users

List the users and service accounts in the Fivetran account with their role, status, and last login, for access reviews.

Input

ParameterTypeRequiredDescription
activebooleanNotrue returns only enabled users, false only suspended ones; omit for both
userTypestringNoOnly return this type: REGULAR_USER or SERVICE_ACCOUNT
hasApiKeybooleanNoOnly return users with (true) or without (false) an API key
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
usersarrayUsers
↳ idstringUser ID
↳ emailstringEmail address
↳ givenNamestringFirst name
↳ familyNamestringLast name
↳ rolestringAccount role
↳ activebooleanWhether the user can log in
↳ verifiedbooleanWhether the email address is verified
↳ invitedbooleanWhether the user was invited
↳ userTypestringREGULAR_USER or SERVICE_ACCOUNT
↳ hasApiKeybooleanWhether the user has an API key, including expired keys
↳ phonestringPhone number
↳ loggedInAtstringLast login time
↳ createdAtstringWhen the user was created
nextCursorstringCursor for the next page; null on the last page

Fivetran List Connector Types

List the source connector types available in Fivetran, with the service ID to use when creating a connection.

Input

ParameterTypeRequiredDescription
cursorstringNoPaging cursor from the nextCursor of a previous page
limitnumberNoNumber of records per page, from 1 to 1000 (default 100)

Output

ParameterTypeDescription
connectorTypesarrayConnector types
↳ idstringService ID used when creating a connection
↳ namestringDisplay name
↳ typestringCategory, e.g. Security or Database
↳ descriptionstringWhat the connector does
↳ connectorClassstringConnector class (standard or lite)
↳ serviceStatusstringAvailability (general_availability, beta, private_preview, sunset, development)
↳ iconUrlstringIcon URL
↳ linkToDocsstringDocumentation URL
↳ linkToErdstringERD URL
↳ supportsSchemaReloadbooleanWhether schema reload is supported
↳ supportedFeaturesarraySupported feature IDs, e.g. RE_SYNC or HISTORY
nextCursorstringCursor for the next page; null on the last page

Fivetran Get Connector Type

Get the configuration and authorization fields a Fivetran connector type takes, to build the config for Create Connection.

Input

ParameterTypeRequiredDescription
servicestringYesConnector type ID, e.g. okta (see List Connector Types)

Output

ParameterTypeDescription
connectorTypeobjectThe connector type
↳ idstringService ID used when creating a connection
↳ namestringDisplay name
↳ typestringCategory, e.g. Security or Database
↳ descriptionstringWhat the connector does
↳ connectorClassstringConnector class (standard or lite)
↳ serviceStatusstringAvailability (general_availability, beta, private_preview, sunset, development)
↳ iconUrlstringIcon URL
↳ linkToDocsstringDocumentation URL
↳ linkToErdstringERD URL
↳ supportsSchemaReloadbooleanWhether schema reload is supported
↳ supportedFeaturesarraySupported feature IDs, e.g. RE_SYNC or HISTORY
configjsonJSON Schema of the configuration fields the connector takes in config
authjsonJSON Schema of the authorization fields the connector takes in auth, if any

Fivetran Update Schema Config

Update how a Fivetran connection handles new schemas, tables, and columns, and enable or disable schemas and tables in one call.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
schemaChangeHandlingstringNoHow new source objects are handled: ALLOW_ALL (sync new schemas, tables, and columns), ALLOW_COLUMNS (only new columns), or BLOCK_ALL
schemasjsonNoSchemas to change, keyed by schema name, e.g. {"public": {"enabled": true, "tables": {"orders": {"enabled": false}}}}

Output

ParameterTypeDescription
schemasjsonSchemas keyed by source schema name, each with name_in_destination, enabled, and tables keyed by table name (name_in_destination, enabled, sync_mode, columns)
enableNewByDefaultbooleanWhether new schemas, tables, and columns are enabled by default
schemaChangeHandlingstringSchema change handling (ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL)
rowFilteringSupportedbooleanWhether row filtering is available for the connection

Fivetran Update Connection Schema

Enable or disable syncing of one schema in a Fivetran connection, optionally changing several of its tables at once.

Input

ParameterTypeRequiredDescription
connectionIdstringYesID of the connection
schemaNamestringYesSchema name as stored in the connection schema config (case-sensitive)
enabledbooleanYesWhether the schema syncs to the destination
tablesjsonNoTables to change in this schema, keyed by table name, e.g. {"orders": {"enabled": false}}

Output

ParameterTypeDescription
schemasjsonSchemas keyed by source schema name, each with name_in_destination, enabled, and tables keyed by table name (name_in_destination, enabled, sync_mode, columns)
enableNewByDefaultbooleanWhether new schemas, tables, and columns are enabled by default
schemaChangeHandlingstringSchema change handling (ALLOW_ALL, ALLOW_COLUMNS, BLOCK_ALL)
rowFilteringSupportedbooleanWhether row filtering is available for the connection

Fivetran Create Group

Create a Fivetran group. Each group holds one destination, so create the group first, then its destination.

Input

ParameterTypeRequiredDescription
namestringYesName of the group

Output

ParameterTypeDescription
groupobjectThe created group
↳ idstringGroup ID
↳ namestringGroup name
↳ createdAtstringWhen the group was created

Fivetran Create Destination

Create the destination for a Fivetran group, such as a Databricks workspace. The config object holds the destination-specific connection settings.

Input

ParameterTypeRequiredDescription
groupIdstringYesID of the group the destination belongs to (each group has one destination)
servicestringYesDestination type, e.g. databricks, snowflake, or big_query
timeZoneOffsetstringYesUTC offset used for sync scheduling, from -11 to +12, e.g. -5 or 0
regionstringNoData processing region, e.g. AWS_US_EAST_1 or GCP_US_EAST4
configjsonNoDestination-specific settings, e.g. for Databricks {"server_host_name": "...", "http_path": "...", "catalog": "...", "auth_type": "PERSONAL_ACCESS_TOKEN", "personal_access_token": "..."}
daylightSavingTimeEnabledbooleanNoShift the UTC offset with daylight saving time (US only)
runSetupTestsbooleanNoRun the setup tests after creating the destination
trustCertificatesbooleanNoAutomatically trust the source certificate during setup tests (default false)
trustFingerprintsbooleanNoAutomatically trust the SSH fingerprint during setup tests (default false)

Output

ParameterTypeDescription
destinationobjectThe created destination, with setup test results when they ran
↳ idstringDestination ID
↳ groupIdstringGroup ID
↳ servicestringDestination type, e.g. databricks
↳ regionstringData processing region
↳ timeZoneOffsetstringUTC offset used for sync scheduling
↳ setupStatusstringSetup status (INCOMPLETE, CONNECTED, BROKEN)
↳ daylightSavingTimeEnabledbooleanWhether the offset shifts with daylight saving time
↳ networkingMethodstringNetworking method
↳ privateLinkIdstringPrivate link ID
↳ hybridDeploymentAgentIdstringHybrid deployment agent ID
↳ proxyAgentIdstringProxy agent ID
↳ setupTestsarraySetup test results
↳ titlestringSetup test step name
↳ statusstringResult (PASSED, SKIPPED, WARNING, FAILED, JOB_FAILED)
↳ messagestringResult message
↳ detailsjsonAdditional diagnostic details

Triggers

A Trigger is a block that starts a workflow when an event happens in this service.

Fivetran All Events

Trigger workflow on any Fivetran sync, connection, or transformation event

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
datajsonEvent-specific payload; its fields depend on the event

Fivetran Connection Created

Trigger workflow when a connection is created

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID

Fivetran Connection Deleted

Trigger workflow when a connection is deleted

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID

Fivetran Connection Edited

Trigger workflow when connection credentials, sync frequency, or other settings change

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID
↳ editTypestringWhat was edited, e.g. CREDENTIALS
↳ oldPropertiesjsonConnector-specific properties before the edit, with secrets masked

Fivetran Connection Failed

Trigger workflow when Fivetran fails to connect to a source

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID
↳ testNamestringName of the setup test
↳ messagestringTest result message

Fivetran Connection Paused

Trigger workflow when a connection is paused, by a user or automatically

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID
↳ reasonstringWhy the connection was paused automatically

Fivetran Connection Re-sync Triggered

Trigger workflow when a historical re-sync of a connection is triggered

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID

Fivetran Connection Resumed

Trigger workflow when a connection is resumed

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID

Fivetran Connection Succeeded

Trigger workflow when Fivetran connects to a source successfully

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID
↳ testNamestringName of the setup test
↳ messagestringTest result message

Fivetran Manual Sync Triggered

Trigger workflow when someone triggers a manual sync of a connection

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID

Fivetran Sync Ended

Trigger workflow when a connection sync finishes, succeeds, fails, or is rescheduled

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ statusstringSync status (SUCCESSFUL, FAILURE, FAILURE_WITH_TASK, RESCHEDULED)
↳ sync_typestringHISTORICAL or INCREMENTAL
↳ load_volume_bnumberBytes loaded into the destination, on successful syncs that report it
↳ reasonstringWhy the sync failed or was rescheduled
↳ taskTypestringError type behind a FAILURE_WITH_TASK or RESCHEDULED status, e.g. reconnect
↳ rescheduledAtstringWhen a rescheduled sync resumes
↳ isRoutinebooleanWhether a reschedule is routine rather than error-driven

Fivetran Sync Started

Trigger workflow when a connection starts syncing

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ sync_typestringHISTORICAL or INCREMENTAL

Fivetran Table Re-sync Triggered

Trigger workflow when a historical re-sync of a table is triggered

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID
triggerConnectionIdstringNoConnection ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ actorstringInternal ID of the user who acted, or _fivetran_system for automatic actions
↳ idstringConnection ID
↳ schemastringSchema name
↳ tablestringTable name

Fivetran Transformation Failed

Trigger workflow when a transformation run fails

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ idstringTransformation job ID
↳ namestringTransformation job name
↳ startTimestringWhen the run started
↳ transformationTypestringJob type (DBT_CORE, QUICKSTART, DBT_CLOUD, COALESCE)
↳ schedulejsonJob schedule (type and entries)
↳ endTimestringWhen the run ended
↳ resultjsonRun result with stepResults (step, success, start and end times, commandResult)

Fivetran Transformation Started

Trigger workflow when a transformation run starts

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ idstringTransformation job ID
↳ namestringTransformation job name
↳ startTimestringWhen the run started
↳ transformationTypestringJob type (DBT_CORE, QUICKSTART, DBT_CLOUD, COALESCE)
↳ schedulejsonJob schedule (type and entries)

Fivetran Transformation Succeeded

Trigger workflow when a transformation run succeeds

Configuration

ParameterTypeRequiredDescription
apiKeystringYesAPI Key
apiSecretstringYesAPI Secret
triggerGroupIdstringNoGroup ID

Output

ParameterTypeDescription
eventstringEvent type, e.g. sync_end
createdAtstringWhen the event was generated (ISO 8601)
connectorTypestringConnector type of the connection, e.g. okta
connectorIdstringConnection ID
connectorNamestringConnection name (its destination schema)
syncIdstringID of the sync the event belongs to
destinationGroupIdstringGroup ID of the destination
dataobjectdata output from the tool
↳ idstringTransformation job ID
↳ namestringTransformation job name
↳ startTimestringWhen the run started
↳ transformationTypestringJob type (DBT_CORE, QUICKSTART, DBT_CLOUD, COALESCE)
↳ schedulejsonJob schedule (type and entries)
↳ endTimestringWhen the run ended
↳ resultjsonRun result with stepResults (step, success, start and end times, commandResult)