> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Airbyte

> How to set up the Airbyte connector, plus the actions and events that are available.

![Airbyte](https://stackone-logos.com/api/airbyte/filled/svg)

v1.0.2[See changelog](https://docs.stackone.com/connectors/airbyte/changelog.md)

[93 actions](#actions) · [3 events](#events) · 1 auth method

Data Integration
IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 (Client Credentials) · Connector Profile](https://docs.stackone.com/connectors/airbyte/guides/connector-profile/oauth-2-0-client-credentials.md)
>
> Uses the client ID and secret of an Airbyte application, which acts as the user who created it with that user's roles. A...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 (Client Credentials) · Link Account](https://docs.stackone.com/connectors/airbyte/guides/link-account/oauth-2-0-client-credentials.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

93 actions

ActionDescription

List Applications`airbyte_list_applications`

List the API applications belonging to the connected user

Get Application`airbyte_get_application`

Get one API application by id

Create Application`airbyte_create_application`

Create an API application for the connected user

Delete Application`airbyte_delete_application`

Delete an API application

List Connections`airbyte_list_connections`

List the Airbyte connections

Get Connection`airbyte_get_connection`

Get one Airbyte connection by id

Create Connection`airbyte_create_connection`

Create a connection between an Airbyte source and destination

Update Connection`airbyte_patch_connection`

Update an Airbyte connection

Delete Connection`airbyte_delete_connection`

Delete an Airbyte connection

List Connector Definitions`airbyte_list_connector_definitions`

List the connector definitions available for sources or destinations

List Declarative Source Definitions`airbyte_list_declarative_source_definitions`

List the no-code declarative source definitions in a workspace

Get Declarative Source Definition`airbyte_get_declarative_source_definition`

Get one declarative source definition by id

Create Declarative Source Definition`airbyte_create_declarative_source_definition`

Create a no-code declarative source definition in a workspace

Update Declarative Source Definition`airbyte_update_declarative_source_definition`

Update a declarative source definition manifest

Delete Declarative Source Definition`airbyte_delete_declarative_source_definition`

Delete a declarative source definition

List Destination Definitions`airbyte_list_destination_definitions`

List the destination connector definitions available in a workspace

Get Destination Definition`airbyte_get_destination_definition`

Get one destination connector definition by id

Create Destination Definition`airbyte_create_destination_definition`

Register a custom destination connector definition in a workspace

Update Destination Definition`airbyte_update_destination_definition`

Update a custom destination connector definition

Delete Destination Definition`airbyte_delete_destination_definition`

Delete a custom destination connector definition

List Destinations`airbyte_list_destinations`

List the configured Airbyte destinations

Get Destination`airbyte_get_destination`

Get one Airbyte destination by id

Create Destination`airbyte_create_destination`

Create a destination in an Airbyte workspace

Update Destination`airbyte_patch_destination`

Partially update an Airbyte destination

Replace Destination`airbyte_put_destination`

Replace an Airbyte destination in full

Delete Destination`airbyte_delete_destination`

Delete an Airbyte destination

Get Embedded Widget Token`airbyte_get_embedded_widget_token`

Get a short-lived token for the Airbyte Embedded widget

Get Health Check`airbyte_get_health_check`

Check that the Airbyte API is reachable

Get Unified Credentials`airbyte_unified_get_me`

Get the current Airbyte connection's unified credentials and identity.

List Unified Groups`airbyte_unified_list_groups`

List unified groups in an Airbyte organization.

Get Unified Group`airbyte_unified_get_group`

Get a unified Airbyte group by ID.

List Unified Organizations`airbyte_unified_list_organizations`

List unified organizations in Airbyte.

Get Unified Organization`airbyte_unified_get_organization`

Get a unified Airbyte organization by ID.

List Unified Roles`airbyte_unified_list_roles`

List unified roles (Airbyte permission types) in Airbyte.

Get Unified Role`airbyte_unified_get_role`

Get a unified Airbyte permission type by ID.

List Unified Users`airbyte_unified_list_users`

List unified users in an Airbyte organization.

Get Unified User`airbyte_unified_get_user`

Get a unified Airbyte user by ID.

List Jobs`airbyte_list_jobs`

List Airbyte sync and reset jobs

Get Job`airbyte_get_job`

Get one Airbyte job by id

Trigger Job`airbyte_create_job`

Trigger a sync, reset, refresh or clear job on a connection

Cancel Job`airbyte_cancel_job`

Cancel a running Airbyte job

List Organizations`airbyte_list_organizations`

List the Airbyte organizations the connected user belongs to

Set Organization OAuth Credentials`airbyte_create_or_update_organization_oauth_credentials`

Override the OAuth app credentials used by a connector type across an organization

Delete Organization OAuth Credentials`airbyte_delete_organization_oauth_credentials`

Remove an organization OAuth credential override

List Permissions`airbyte_list_permissions`

List the role permissions held by an Airbyte user

Get Permission`airbyte_get_permission`

Get one Airbyte permission by id

Create Permission`airbyte_create_permission`

Grant an Airbyte user a role in an organization or workspace

Update Permission`airbyte_update_permission`

Change the role on an existing Airbyte permission

Delete Permission`airbyte_delete_permission`

Revoke an Airbyte permission

List Regions`airbyte_list_regions`

List the regions available to an Airbyte organization

List SCIM Users`airbyte_scim_list_users`

List the SCIM user mappings in the organization

Get SCIM User`airbyte_scim_get_user`

Get one SCIM user mapping by id

Create SCIM User`airbyte_scim_create_user`

Provision a new user into the organization over SCIM

Replace SCIM User`airbyte_scim_replace_user`

Replace a SCIM user mapping in full

Patch SCIM User`airbyte_scim_patch_user`

Apply partial SCIM changes to a user

Delete SCIM User`airbyte_scim_delete_user`

Deprovision a user over SCIM

List SCIM Groups`airbyte_scim_list_groups`

List the SCIM groups in the organization

Get SCIM Group`airbyte_scim_get_group`

Get one SCIM group by id

Create SCIM Group`airbyte_scim_create_group`

Create a SCIM group in the organization

Replace SCIM Group`airbyte_scim_replace_group`

Replace a SCIM group in full

Patch SCIM Group`airbyte_scim_patch_group`

Apply partial SCIM changes to a group

Delete SCIM Group`airbyte_scim_delete_group`

Delete a SCIM group

List SCIM Resource Types`airbyte_scim_list_resource_types`

List the resource types the SCIM service supports

Get SCIM Resource Type`airbyte_scim_get_resource_type`

Get one SCIM resource type by id

List SCIM Schemas`airbyte_scim_list_schemas`

List the SCIM schemas the service supports

Get SCIM Schema`airbyte_scim_get_schema`

Get one SCIM schema by URN

Get SCIM Service Provider Config`airbyte_scim_get_service_provider_config`

Get the SCIM features this Airbyte organization supports

List Source Definitions`airbyte_list_source_definitions`

List the source connector definitions available in a workspace

Get Source Definition`airbyte_get_source_definition`

Get one source connector definition by id

Create Source Definition`airbyte_create_source_definition`

Register a custom source connector definition in a workspace

Update Source Definition`airbyte_update_source_definition`

Update a custom source connector definition

Delete Source Definition`airbyte_delete_source_definition`

Delete a custom source connector definition

List Sources`airbyte_list_sources`

List the configured Airbyte sources

Get Source`airbyte_get_source`

Get one Airbyte source by id

Create Source`airbyte_create_source`

Create a source in an Airbyte workspace

Update Source`airbyte_patch_source`

Partially update an Airbyte source

Replace Source`airbyte_put_source`

Replace an Airbyte source in full

Delete Source`airbyte_delete_source`

Delete an Airbyte source

Initiate Source OAuth`airbyte_initiate_oauth`

Start the OAuth consent flow for a source connector

Get Stream Properties`airbyte_get_stream_properties`

Discover the streams a source exposes and the sync modes they support

List Tags`airbyte_list_tags`

List the connection tags in a workspace

Get Tag`airbyte_get_tag`

Get one connection tag by id

Create Tag`airbyte_create_tag`

Create a connection tag in a workspace

Update Tag`airbyte_update_tag`

Update a connection tag

Delete Tag`airbyte_delete_tag`

Delete a connection tag

List Users`airbyte_list_users`

List the members of an Airbyte organization

List Workspaces`airbyte_list_workspaces`

List the Airbyte workspaces the connected user can access

Get Workspace`airbyte_get_workspace`

Get one Airbyte workspace by id

Create Workspace`airbyte_create_workspace`

Create an Airbyte workspace

Update Workspace`airbyte_update_workspace`

Update an Airbyte workspace

Delete Workspace`airbyte_delete_workspace`

Delete an Airbyte workspace

Set Workspace OAuth Credentials`airbyte_create_or_update_workspace_oauth_credentials`

Override the OAuth app credentials used by a connector type in a workspace

Delete Workspace OAuth Credentials`airbyte_delete_workspace_oauth_credentials`

Remove a workspace OAuth credential override

## Events

Tags

Select all
|
Clear

Jobs

Webhooks

No tags found

3 events

EventDescriptionTags

Webhook Acknowledgement`airbyte_webhook_acknowledge`

Acknowledges a delivery that carries no sync result with a 200 and emits nothing.

Webhooks

Sync Succeeded Webhook`airbyte_webhook_sync_succeeded`

Fired when a connection finishes a sync successfully.

JobsWebhooks

Sync Failed Webhook`airbyte_webhook_sync_failed`

Fired when a connection's sync fails.

JobsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.