Configuration section: source_connectors

Description

A detailed description is available in the Source Connectors section.

The configuration for each Source Connector can be split into:

• A "wrapper" which indicates the connector to be launched
• An "inner section" which contains connector-specific configuration

The "wrapper" is covered in this documentation section while each Source Connector has its dedicated documentation page under the Source Connectors section.

Specification

connector (string, required)

Connector slug used in config (lowercase), e.g., bamboohr, payanalytics.

secrets (string[], required)

A list of names to indicate which secrets to send into the connector.

configuration (object, required)

Connector specific. See Source Connectors

Example

One of the built-in connectors is a demonstration connector which fetches data from an open data source (the Star Wars API). The connector returns a list of Star Wars characters and is useful for testing purposes as it does not require any credentials.

{
  "version": 1,
  "source_connectors": [
    {
      "connector": "star_wars_api",
      "configuration": {
        "dataset_prefix": "example_run"
      }
    } 
  ]
}