​
What are Target Settings?

Target settings determine:

  • How a Target appears to your tenants
  • How you and your tenants authenticate to the Target
  • The underling taps and targets that your Target uses

​
Example Target Settings

{
  "target": "postgres-beta",
  "flowType": "all",
  "domain": "postgresql.org",
  "label": "PostgreSQL",
  "version": "v2",
  "type": "api",
  "icon": "https://s3.amazonaws.com/cdn.hotglue.xyz/images/logos/postgres.svg",
  "validation_supported": true,
  "connect_ui_params": {
    "host": {
      "label": "Host Name",
      "description": "Your PostgreSQL server host"
    },
    "port": {
      "label": "Port",
      "description": "Your PostgreSQL server port"
    },
    "dbname": {
      "label": "Database",
      "description": "Your PostgreSQL database name"
    },
    "user": {
      "label": "User",
      "description": "Your PostgreSQL user"
    },
    "password": {
      "label": "Password",
      "description": "Your PostgreSQL password",
      "type": "password"
    },
    "default_target_schema": {
      "label": "Schema",
      "description": "Your PostgreSQL schema (ie. public)"
    },
  },
  "connector_props": {
    "singer_sdk": true
  }
}

​
Understanding the Target Fields

​
id

The id field is a unique identifier for the Target. It is used internally to reference the Target and should be unique across all Targets.

​
label

The label field is a human-readable name for the Target. This is the name that will be displayed in the user interface.

​
icon

The icon field is a URL to an image that represents the Target. This icon will be displayed in the user interface alongside the Target’s label.

​
tags

The tags field is an array of strings that categorize the Target. These tags can be used to filter and search for Targets.

​
domain

The domain field specifies the primary domain associated with the Target. This is typically the domain of the service the Target integrates with.

​
type

The type field specifies the authentication method used by the Target. Accepted values are oauth and api

​
isForked

The isForked field indicates whether this Target has been modified from the default Hotglue Target settings.

​
install_uri

The install_uri field can be used to overwrite the default git repo that the Target will be installed from:

"install_uri": "git+https://github.com/your-org/target-bigquery.git@v1.2.4"

You can also override the install_uri for particular tenants by instead using:

"install_uri": {
  "env": "git+..." // Default install URI,
  "tenant": {
    "TENANT_ID": "git+..." // Install URI for particular tenant
  }
}