Fetch important details about the connectors that you can enable in your environment

There are two important lists of connectors:

  • Available Connectors refers to all connectors that you can use with hotglue. Any singer tap or target can be an Available Connector, and new connectors are added to our library every week.
  • Supported Connectors are the connectors that are enabled in a given flow. Connectors are enabled by linking them in your admin panel with default tenant.

The Available Connectors and Supported Connectors arrays contain metadata that defines how authentication is handled and how the widget works. You can modify widget and authentication behavior by creating forks of your available connectors using the CLI.

Below is a sample Available Connector for Stripe. The most important parts of these objects are below:

  • id is how you refer to the connector in your API calls
  • connect_ui_params are the fields that are displayed in the widget. You can add additional params here, e.g. to enable flags.
  • read_connector and write_connector refer to the taps and targets that are used for read and write jobs.
  {
    "id": "stripe",
    "connect_ui_params": {
      "client_secret": {
        "label": "Stripe Secret Key",
        "description": "Your Stripe secret key (sk_live_xxxxxxx)",
        "type": "password"
      },
      "account_id": {
        "label": "Stripe Account ID",
        "description": "Your Stripe account id (acct_xxxxxx)"
      }
    },
    "domain": "stripe.com",
    "icon": "https://s3.amazonaws.com/cdn.hotglue.xyz/images/logos/stripe.svg",
    "isConnector": true,
    "isSource": false,
    "isTarget": false,
    "label": "Stripe",
    "options": {
      "auto_support": true,
      "validation_supported": true,
      "config": {
        "start_date": "2000-01-01T00:00:00.000Z"
      }
    },
    "read_connector": {
      "id": "stripe-v2",
      "install_uri": "git+https://gitlab.com/hotglue/tap-stripe-v2.git"
      "singer_sdk": true
    },
    "tags": [
      "billing"
    ],
    "type": "api"