Skip to main content

Airbyte

The Airbyte activity triggers a sync on an Airbyte connection and waits for it to complete before the workflow continues.

Prerequisites

An Airbyte data source must be configured in Una with the Airbyte API credentials and server URL.

Configuration

Data Source

Select the Airbyte data source. Only data sources of type Airbyte are available.

Connection Id

The Airbyte Connection ID (UUID) of the connection to sync. This is found in the Airbyte UI under the connection settings.

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

The field label in the editor is Connection Id, not Pipeline Name. Do not put the connection name here — put the UUID.

Behavior

  1. The connection sync is triggered via the Airbyte API.
  2. The activity polls for job status using incremental wait intervals.
  3. If the job response is null or indicates failure, the activity throws an exception and returns Error.
  4. When the job is no longer running and reports success, the activity returns Success.
  5. Status is logged at each poll interval for visibility in the workflow run log.

Usage Notes

  • Airbyte sync failures surface as Error status. Always wire an error arrow.
  • The Connection ID is a UUID, not the human-readable connection name. Copy it from the Airbyte connection URL or settings page.
  • Detailed sync logs (record counts, schema drift, error details) are available in the Airbyte UI.
  • The activity does not support passing parameters to an Airbyte sync — parameter configuration is done in Airbyte itself.

Usage Patterns

Sync Then Load

Airbyte ──> ETL ("Import_From_Airbyte_Staging")
└── Connection Id: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Best Practices

  • Store the Connection ID in a workflow variable or use a descriptive activity name so the ID's purpose is clear in the workflow.
  • Wire an error arrow so Airbyte sync failures are immediately visible and routed to a notification.

JSON Reference

{
"discriminator": "AirbyteWorkflowActivity",
"activityId": "<uuid>",
"name": "Airbyte Sync",
"positionX": 0,
"positionY": 0,
"advanceRule": 2,
"dataSource": "MyAirbyteConnection",
"pipelineName": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"parameters": []
}
PropertyTypeDescription
dataSourcestringCorresponds to the Data Source field. The Airbyte data source.
pipelineNamestringCorresponds to the Connection Id field. The Airbyte Connection ID (UUID) of the connection to sync. Supports {variable} interpolation.
parametersarrayNot used by Airbyte sync (parameters are configured in Airbyte itself). Pass an empty array [].