Source Templates

Cloud Self-Managed CommunitySelf-Managed EnterpriseEmbedded Compare

A source template controls which connectors appear in the Embedded widget and how their config screens look. When a customer opens the widget, only the sources backed by a template are selectable—so you can pre‑set sensible defaults or restrict advanced settings.

The Airbyte platform comes with ready to use templates. You can also create templates specific to your organization if you need access to more integrations or if you want different default values.

Here is an example request to create a new template using only default values

curl https://api.airbyte.ai/api/v1/integrations/sources\
-H 'authorization: Bearer <token>'
-H 'content-type: application/json' \
--data-raw '{"organization_id":"<organization_id>","actor_definition_id":"<definition_id>","partial_default_config":{}, "additional_required_parameters": []}' -vvv

You can find the actor definition ID from the Connector Registry.

The partial_default_config is a JSON object representing keys from the connector spec for which you want to set default values so your users don't need to set them up themselves.

Deleting Templates

You can delete Source Templates by submitting a DELETE request to the API.

Sources created from a deleted Source Template will stop showing up in the Widget.

Updating Templates

You can update existing Source Templates using the following API endpoint.

When a Source Template is updated, all existing Sources created from it will also be updated.

Listing Templates

The List Source Templates endpoint both the templates you created, as well as standard templates that are available to everyone using the platform.