Airbyte Sync

Airbyte Sync

Certified

Run an Airbyte Cloud sync

Starts a sync job for an Airbyte Cloud connection. By default, the task waits for completion and emits sync metrics

yaml
type: io.kestra.plugin.airbyte.cloud.jobs.Sync
yaml
id: airbyte_sync
namespace: company.team

tasks:
  - id: sync
    type: io.kestra.plugin.airbyte.cloud.jobs.Sync
    token: "{{ secret('AIRBYTE_TOKEN') }}"
    connectionId: e3b1ce92-547c-436f-b1e8-23b6936c12cd
Properties

Connection ID

Airbyte Cloud connection ID for the job

Client ID

Airbyte application client ID used for client-credentials authentication

Client secret

Airbyte application client secret used for client-credentials authentication. Store this value in a Secret

DefaultPT1H

Maximum wait duration

Maximum total time to wait for the job to finish. Defaults to 60 minutes

Basic auth password

Password for Airbyte Cloud basic authentication. Store this value in a Secret

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

DefaultPT1S

Poll frequency

Interval between Airbyte Cloud job status checks. Defaults to 1 second

Bearer token

Bearer token for the Airbyte Cloud API. If this is set, it is used before client credentials or basic auth

Defaulthttps://api.airbyte.com/v1/applications/token

Token URL

Token endpoint used with client credentials. Defaults to https://api.airbyte.com/v1/applications/token. See: https://reference.airbyte.com/reference/createaccesstoken

Basic auth username

Username for Airbyte Cloud basic authentication. Basic auth is used only when no bearer token or client credentials are configured

Defaulttrue

Wait for completion

If true, wait for the Airbyte Cloud job to reach a terminal state before the task completes. Defaults to true

Job details

Airbyte Cloud job returned by the task

Definitions
bytesSyncedinteger

Bytes synced

Number of bytes synced by the job

durationstring
Formatduration

Duration

Total duration of the job

jobIdinteger

Job ID

Airbyte Cloud job ID

jobTypestring
Possible Values
SYNCRESETREFRESHCLEAR

Job type

Type of job (e.g. SYNC or RESET)

lastUpdatedAtstring
Formatdate-time

Last updated at

Timestamp when the job was last updated

rowsSyncedinteger

Rows synced

Number of rows synced by the job

startTimestring
Formatdate-time

Start time

Timestamp when the job started

statusstring
Possible Values
PENDINGRUNNINGINCOMPLETEFAILEDSUCCEEDEDCANCELLED

Status

Terminal job status

More Plugins in this Category

Liquibase
Liquibase

Tasks that run Liquibase change management commands.

Data

2 tasks

PostgreSQL
PostgreSQL

Tasks that connect to PostgreSQL via JDBC to run queries and loads.

Data

6 tasks

25 blueprints