
Airbyte Sync
CertifiedRun an Airbyte Cloud sync
Airbyte Sync
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
type: io.kestra.plugin.airbyte.cloud.jobs.SyncExamples
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
connectionId *string
Connection ID
Airbyte Cloud connection ID for the job
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150clientId string
Client ID
Airbyte application client ID used for client-credentials authentication
clientSecret string
Client secret
Airbyte application client secret used for client-credentials authentication. Store this value in a Secret
maxDuration string
PT1HMaximum wait duration
Maximum total time to wait for the job to finish. Defaults to 60 minutes
password string
Basic auth password
Password for Airbyte Cloud basic authentication. Store this value in a Secret
pollFrequency string
PT1SPoll frequency
Interval between Airbyte Cloud job status checks. Defaults to 1 second
token string
Bearer token
Bearer token for the Airbyte Cloud API. If this is set, it is used before client credentials or basic auth
tokenURL string
https://api.airbyte.com/v1/applications/tokenToken URL
Token endpoint used with client credentials. Defaults to https://api.airbyte.com/v1/applications/token. See: https://reference.airbyte.com/reference/createaccesstoken
username string
Basic auth username
Username for Airbyte Cloud basic authentication. Basic auth is used only when no bearer token or client credentials are configured
wait booleanstring
trueWait for completion
If true, wait for the Airbyte Cloud job to reach a terminal state before the task completes. Defaults to true
Outputs
job
Job details
Airbyte Cloud job returned by the task
io.kestra.plugin.airbyte.cloud.jobs.AbstractTrigger-Job
Bytes synced
Number of bytes synced by the job
durationDuration
Total duration of the job
Job ID
Airbyte Cloud job ID
SYNCRESETREFRESHCLEARJob type
Type of job (e.g. SYNC or RESET)
date-timeLast updated at
Timestamp when the job was last updated
Rows synced
Number of rows synced by the job
date-timeStart time
Timestamp when the job started
PENDINGRUNNINGINCOMPLETEFAILEDSUCCEEDEDCANCELLEDStatus
Terminal job status