Airbyte

Airbyte is an open-source data integration platform that moves data from sources into warehouses, lakes, and databases through a large catalog of connectors. Its REST API lets you programmatically manage workspaces, source definitions, and notification settings across an Airbyte deployment. This connector uses the Airbyte API to read and manage those resources from within Nexla.

Power end-to-end data operations for your Airbyte API with Nexla. Our bi-directional Airbyte connector is purpose-built for Airbyte, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Airbyte or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Airbyte workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

• Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
• Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
• API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
• Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Airbyte credential, you need an API access token for your Airbyte deployment. The Airbyte API authenticates requests with a bearer token that is sent in the Authorization header as Bearer <token>. Access tokens are generated from an Airbyte Application, which is identified by a client ID and client secret.

To obtain an Airbyte API access token, follow these steps:

1. Sign in to your Airbyte account (Airbyte Cloud or your self-managed deployment).

2. Click your user name in the lower-left corner, then open User settings and select Applications.

3. Click Create an application, enter a descriptive name (e.g., "Nexla Integration"), and click Submit. Airbyte generates a client ID and client secret for the application.

4. Generate an access token from the application. You can either use the Generate access token action in the Applications screen to copy a token directly, or exchange your client ID and client secret programmatically by sending a POST request to the https://api.airbyte.com/v1/applications/token endpoint.

5. Copy the generated access token. This is the value you will supply to Nexla as the API Key Value.

Airbyte access tokens are short-lived and are intended to be refreshed regularly (the exact lifetime depends on your deployment type). Because a token can expire, keep your application's client ID and client secret available so you can generate a new token when needed.

For complete details about applications, token generation, and API authentication, see the Airbyte API access documentation and the Airbyte API reference.

Authenticate

Credentials required

An authentication method that requires sending a unique secret token with each API request

Field	Required	Secret	Description
API Key Value	Yes	Yes	An encoded string value used as a secret token to authenticate API requests

Create a credential in Nexla

1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

3. Enter your Airbyte API access token in the API Key Value field. This token is sent in the Authorization header as Bearer <token> to authenticate all requests to the Airbyte API and must be kept confidential.

   If your access token is compromised, generate a new token from your Airbyte application and update this credential. Because Airbyte access tokens are short-lived, you may need to refresh the token value periodically to keep the credential valid.

4. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Airbyte connector tile, then select the credential that will be used to connect to Airbyte, and click Next; or, create a new Airbyte credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Airbyte endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] Creates a workspace

This endpoint template creates a new workspace in your Airbyte deployment and returns the resulting workspace record. Use this template when you need to provision workspaces as part of a Nexla flow.

• Provide the workspace attributes (such as name, email, and organization ID) required by the Airbyte API. Nexla submits these values in the request body when the source runs.

[Rest API] Creates a workspace with an explicit workspace ID (intended for acceptance tests only)

This endpoint template creates a workspace using an explicit workspace ID that you provide. As noted in the Airbyte API, this operation is intended for acceptance tests only.

• Supply the workspace ID along with the other workspace attributes. Nexla submits these values in the request body when the source runs.

[Rest API] List workspaces by workspace IDs (supports pagination)

This endpoint template lists workspaces registered in the current Airbyte deployment by the workspace IDs you provide. This operation also supports pagination.

• Provide the workspace IDs to filter on, and optionally pagination and name-filter parameters. Nexla returns the matching workspace records from the response.

[Rest API] List workspaces in an organization (supports keyword search and pagination)

This endpoint template lists the workspaces that belong to a given organization ID. This operation also supports searching by keyword and pagination.

• Provide the organization ID, and optionally a name filter and pagination parameters. Nexla returns the matching workspace records from the response.

[Rest API] List workspaces by user (supports keyword search and pagination)

This endpoint template lists the workspaces associated with a given user ID. This operation also supports searching by keyword and pagination.

• Provide the user ID, and optionally a name filter and pagination parameters. Nexla returns the matching workspace records from the response.

[Rest API] Get available dbt jobs for a workspace

This endpoint template calls the dbt Cloud List Accounts and List Jobs APIs to return the dbt jobs available to the dbt auth token associated with the requested workspace configuration.

• Provide the workspace ID and the dbt config ID. Nexla returns the list of available dbt jobs from the response.

[Rest API] Find workspace by ID

This endpoint template retrieves a single workspace by its workspace ID. Use this template when you need the details of a specific workspace.

• Provide the workspace ID, and optionally whether to include tombstoned (soft-deleted) workspaces. Nexla returns the matching workspace record from the response.

[Rest API] Find workspace by slug

This endpoint template retrieves a single workspace by its slug. Use this template when you know a workspace's slug but not its ID.

• Provide the workspace slug. Nexla returns the matching workspace record from the response.

[Rest API] Find workspace by connection ID

This endpoint template retrieves the workspace that owns a given connection ID. Use this template to resolve a connection back to its parent workspace.

• Provide the connection ID. Nexla returns the matching workspace record from the response.

[Rest API] Find workspace by connection ID (including tombstoned workspaces)

This endpoint template retrieves the workspace that owns a given connection ID, including tombstoned (soft-deleted) workspaces. Use this template when you need to resolve connections that may belong to a deleted workspace.

• Provide the connection ID. Nexla returns the matching workspace record from the response.

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Airbyte data sources can also be manually configured to ingest data from any valid Airbyte API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Airbyte data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Airbyte destination, and select the Send to Destination option from the menu. Select the Airbyte connector from the list of available destination connectors, then select the credential that will be used to connect to Airbyte, and click Next; or, create a new Airbyte credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Airbyte endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Deletes a workspace

This endpoint template deletes a workspace in your Airbyte deployment using records from a Nexset. Use this template when you need to remove workspaces based on data from your Nexla flows.

• Each record should identify the workspace to delete (by workspace ID). Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Update workspace feedback state

This endpoint template updates the feedback state of a workspace, tagging its feedback status as done. Use this template to record feedback state changes from your Nexla flows.

• Each record should identify the workspace to update (by workspace ID). Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Try sending a notification (to be deprecated)

This endpoint template sends a test notification using the notification configuration in each record. As noted in the Airbyte API, this operation is slated to be deprecated.

• Each record should contain the notification configuration to test. Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Try sending a notification to a webhook

This endpoint template sends a test notification to a webhook using the configuration in each record. Use this template to validate webhook notification settings from your Nexla flows.

• Each record should contain the webhook notification configuration to test. Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Update a source definition

This endpoint template updates an existing source definition in your Airbyte deployment using records from a Nexset. Use this template to modify source definitions based on data from your Nexla flows.

• Each record should contain the source definition ID and the attributes to update (such as name, Docker image tag, or resource requirements). Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Delete a source definition

This endpoint template deletes a source definition in your Airbyte deployment using records from a Nexset. Use this template to remove source definitions based on data from your Nexla flows.

• Each record should identify the source definition to delete (by source definition ID). Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Create a custom source definition

This endpoint template creates a custom source definition for a given workspace or organization using records from a Nexset. Use this template to register custom source definitions from your Nexla flows.

• Each record should contain the scope (workspace or organization), scope ID, and the source definition to create. Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Grant a source definition to a workspace or organization

This endpoint template grants a private, non-custom source definition to a given workspace or organization using records from a Nexset.

• Each record should contain the actor definition ID and the target scope and scope ID. Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Revoke a source definition grant from a workspace or organization

This endpoint template revokes a grant to a private, non-custom source definition from a given workspace or organization using records from a Nexset.

• Each record should contain the actor definition ID and the target scope and scope ID. Nexla sends each record to the Airbyte API as a separate request.

[Rest API] Resolve an actor definition version by tag

This endpoint template resolves an actor definition version by its version tag using records from a Nexset. Use this template to look up a specific actor definition version from your Nexla flows.

• Each record should contain the actor definition ID, actor type, and Docker image tag. Nexla sends each record to the Airbyte API as a separate request.

Manual configuration

Airbyte destinations can also be manually configured to send data to any valid Airbyte API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Airbyte endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Airbyte endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.