Fivetran Status

Fivetran Status

Certified

Read the status of one or more Fivetran connectors, optionally gating on freshness

Reads each connector's current status through a single GET call per connector. Never triggers a sync. By default (wait: true), polls until every connector is fresh so downstream tasks only run once the underlying data is up to date; set wait: false for a single read-only snapshot. With assets.enableAuto set, emits one asset per table each connector writes, with the id database.schema.name so it joins the dbt model reading that table in the lineage graph.

yaml
type: io.kestra.plugin.fivetran.connectors.Status
yaml
id: fivetran_status_gate
namespace: company.team

tasks:
  - id: wait_until_fresh
    type: io.kestra.plugin.fivetran.connectors.Status
    apiKey: "{{ secret('FIVETRAN_API_KEY') }}"
    apiSecret: "{{ secret('FIVETRAN_API_SECRET') }}"
    connectorIds:
      - connector_id_1
      - connector_id_2
    freshnessBuffer: PT10M

  - id: run_after_fresh_data
    type: io.kestra.plugin.core.log.Log
    message: "Connectors are fresh: {{ outputs.wait_until_fresh.connectors }}"
yaml
id: fivetran_status_snapshot
namespace: company.team

tasks:
  - id: status
    type: io.kestra.plugin.fivetran.connectors.Status
    apiKey: "{{ secret('FIVETRAN_API_KEY') }}"
    apiSecret: "{{ secret('FIVETRAN_API_SECRET') }}"
    connectorIds:
      - connector_id_1
      - connector_id_2
    wait: false
Properties

Fivetran API key

Required; paired with apiSecret for HTTP Basic authentication.

Fivetran API secret

Required secret token used with apiKey for Basic authentication.

SubTypestring

Connector IDs

Identifiers of the Fivetran connectors whose status should be read.

Defaultfalse

Allow terminal-state connectors instead of failing fast

When wait is true, a paused connector or one whose setup is not connected can never become fresh, so the task fails fast by default instead of polling forever. Set to true to report such connectors as not-fresh instead, letting the gate wait out maxDuration.

Defaulthttps://api.fivetran.com

Fivetran API base URL

Base endpoint for all requests. Defaults to https://api.fivetran.com; override for regional or private deployments.

DefaultPT0S

Freshness buffer

Buffer added on top of each connector's syncFrequency when deciding whether its last sync is fresh. Default is no buffer (PT0S).

DefaultPT1S

Initial delay before the first retry

Backoff grows from this delay, capped at 30 seconds. Default: 1 second.

Default3

Maximum number of attempts on transient errors

Total attempts including the first call, not just retries. Default: 3.

DefaultPT1H

Maximum wait duration

Upper bound for waiting when wait is true. Default is 1 hour.

HTTP client options

Optional Kestra HTTP configuration (timeouts, proxy) applied to Fivetran calls. Retries are configured separately via maxAttempts and initialRetryDelay.

Definitions
allowFailedbooleanstring
Defaultfalse

If true, allow a failed response code (response code >= 400)

allowedResponseCodesarray
SubTypeinteger

List of response code allowed for this request

auth

The authentication to use.

type*Requiredobject
passwordstring

The password for HTTP basic authentication.

usernamestring

The username for HTTP basic authentication.

type*Requiredobject
tokenstring

The token for bearer token authentication.

type*Requiredobject
passwordstring

The password for HTTP Digest authentication.

usernamestring

The username for HTTP Digest authentication.

basicAuthPasswordDeprecatedstring

The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

basicAuthUserDeprecatedstring

The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.

connectTimeoutDeprecatedstring
Formatduration

The time allowed to establish a connection to the server before failing.

connectionPoolIdleTimeoutDeprecatedstring
Formatduration

The time an idle connection can remain in the client's connection pool before being closed.

defaultCharsetstring
DefaultUTF-8

The default charset for the request.

enabledTcpExtendedKeepAlivebooleanstring
Defaulttrue

Whether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).

Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.

followRedirectsbooleanstring
Defaulttrue

Whether redirects should be followed automatically.

logLevelDeprecatedstring
Possible Values
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIED

The log level for the HTTP client.

logsarray
SubTypestring
Possible Values
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

maxContentLengthDeprecatedinteger

The maximum content length of the response.

proxy

The proxy configuration.

addressstring

The address of the proxy server.

passwordstring

The password for proxy authentication.

portintegerstring

The port of the proxy server.

typestring
DefaultDIRECT
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

usernamestring

The username for proxy authentication.

proxyAddressDeprecatedstring

The address of the proxy server.

proxyPasswordDeprecatedstring

The password for proxy authentication.

proxyPortDeprecatedinteger

The port of the proxy server.

proxyTypeDeprecatedstring
Possible Values
DIRECTHTTPSOCKS

The type of proxy to use.

proxyUsernameDeprecatedstring

The username for proxy authentication.

readIdleTimeoutDeprecatedstring
Formatduration

The time allowed for a read connection to remain idle before closing it.

readTimeoutDeprecatedstring
Formatduration

The maximum time allowed for reading data from the server before failing.

ssl

The SSL request options

insecureTrustAllCertificatesbooleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

timeout

The timeout configuration.

connectTimeoutstring

The time allowed to establish a connection to the server before failing.

readIdleTimeoutstring
DefaultPT5M

The time allowed for a read connection to remain idle before closing it.

Reference (ref) of the pluginDefaults to apply to this task.

DefaultPT30S

Poll frequency

Interval between connector status checks while waiting for freshness. Default is 30 seconds. Must not be greater than maxDuration.

Defaulttrue

Wait until every connector is fresh

When true (default), poll all connectors until each one is fresh, capped by maxDuration. Set to false to read each connector once and report its status without gating.

Connector statuses

Map of connector ID to its current status, in the order the IDs were requested.

Definitions
completedDatestring
Formatdate-time

Timestamp of the most recent sync completion

Whichever of succeededAt or failedAt is more recent.

failedAtstring
Formatdate-time

Timestamp of the last failed sync

freshboolean

Whether the connector's last sync is fresh

True when the last sync succeeded within syncFrequency plus freshnessBuffer of now. False when stale, or the last completion was a failure. Null when Fivetran reported no syncFrequency for this connector, so freshness cannot be computed.

hasFailedboolean
Defaultfalse

Whether the last sync completion was a failure

True only when the most recent failedAt is not followed by a later succeededAt.

idstring

Connector ID

namestring

Connector name

pausedboolean

Whether the connector is paused

scheduleTypestring

Schedule type

Either auto or manual.

schemaStatusstring

Current schema status

As reported by Fivetran, e.g. ready, blocked.

setupStatestring

Current setup state

As reported by Fivetran, e.g. connected, broken, incomplete.

succeededAtstring
Formatdate-time

Timestamp of the last successful sync

syncFrequencyinteger

Sync frequency in minutes

syncStatestring

Current sync state

As reported by Fivetran, e.g. scheduled, syncing, paused, rescheduled.

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

6 blueprints

Redis
Redis

Tasks that work with Redis data structures and pub/sub.

Data

18 tasks

6 blueprints