The Available Sources and Supported Sources arrays contain JSON objects defining your hotglue sources.

There are two metadata objects that can help you understand how authentication is handled, custom flags, how the widget looks, and more:

  • Available Sources refers to all sources that you can use with hotglue. Each available source defines a specific Singer spec tap to be used in fetching data, which means that any singer tap can be an Available Source. You can also create forks of your Available Sources via the CLI to modify widget and authentication behavior.
  • Supported Sources are the sources that are enabled in a given flow. Sources are enabled by linking them in your admin panel with default tenant.

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

  • tap is how you refer to the connector in your API calls. Note that there may be multiple versions for the same connector (e.g. quickbooks and quickbooks:sandbox or stripe and stripe-v2)
  • connect_ui_params are the fields that are displayed in the widget. You can add additional params here, e.g. to enable flags.
  • install_uri optionally overrides the default repository for your integration. This may be relevant if you frequently test updates to hotglue taps in your QA hotglue environment.
  {
    "tap": "stripe-v2",
    "tags": [
      "billing"
    ],
    "domain": "stripe.com",
    "label": "Stripe",
    "version": "v2",
    "type": "api",
    "icon": "https://s3.amazonaws.com/cdn.hotglue.xyz/images/logos/stripe.svg",
    "auto_support": true,
    "validation_supported": true,
    "connect_ui_params": {
      "client_secret": {
        "label": "Stripe Secret Key",
        "description": "Your Stripe secret key (sk_live_xxxxxxx)",
        "type": "password"
      }
    },
    "config": {
      "start_date": "2000-01-01T00:00:00.000Z"
    },
    "connector_props": {
      "singer_sdk": true
    }
  }