Breadcrumbs

Airbyte - Trigger Sync

Overview

Execute a sync against an existing connector in the Airbyte interface.

Variables

Name

Reference

Type

Required

Default

Options

Description

Connection ID

AIRBYTE_CONNECTION_ID

Alphanumeric

✅

-

-

The ID of the sync to trigger

API Token

AIRBYTE_API_TOKEN

Password

✅

-

-

The API token generated by Airbyte

Wait For Completion

AIRBYTE_WAIT

Boolean

➖

TRUE

-

Enable if you want the vessel to wait until the sync job is successfully completed. Otherwise, the vessel will only initiate the sync job without waiting

YAML

Below is the YAML template

YAML

source:
  template: Airbyte - Trigger Sync
  inputs:
    AIRBYTE_CONNECTION_ID:
    AIRBYTE_API_TOKEN:
    AIRBYTE_WAIT: 'TRUE'
  type: TEMPLATE
guardrails:
  retry_count: 1
  retry_wait: 0h0m0s
  runtime_cutoff: 1h0m0s
  exclude_exit_code_ranges:
    - 200
    - 201
    - 202
    - 203
    - 204
    - 210
    - 211
    - 212
    - 213
    - 214
    - 215
    - 220