Managing Airbyte Embedded

Cloud Self-Managed CommunitySelf-Managed EnterpriseEmbedded Compare

Customer Workspaces

Airbyte Embedded is built upon the Airbyte Platform. As the owner of your embedded instance, you access Airbyte via the standard sign-in. Each customer who configures a source via the Embedded Widget is automatically assigned a workspace. Within this workspace, data pipelines are created between the source and staging store, which you configured in the pre-requisite section of this guide. In this example, the staging store is S3.

Enabling Connectors within the Widget

Source connectors can be configured to appear in the Embedded widget by creating a configuration template via the config_templates/sources API endpoint.

The following example demonstrates how to use the API to create a new configuration template for the Faker connector, with a required “count” field. To obtain the source_connector_definition_id, you can access this via the Airbyte Connector Registry.

curl --request GET \
  --url https://api.airbyte.com/v1/config_templates/sources \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer  <bearer_token>' \
  --data '{
    "organizationId": "<organization_id>",
    "partialDefaultConfig": {},
    "partialUserConfigSpec": {
      "connectionSpecification": {
        "$schema": "http://json-schema.org/draft-07/schema#",
        "title": "Faker Source Spec",
        "type": "object",
        "required": ["count"],
        "properties": {
          "count": {
          "title": "Count",
          "description": "How many users should be generated in total. The purchases table will be scaled to match, with 10 purchases created per 10 users. This setting does not apply to the products stream.",
          "type": "integer",
          "minimum": 1,
          "default": 5000,
          "order": 0
        }

        }
      }
    },
    "actorDefinitionId": "<source_connector_definition_id>"
  }'

note

This endpoint is only available to Embedded customers. You can only create new configuration templates, not update, modify, or delete existing ones.