Skip to main content

​
What are Connector Settings?

Connector settings determine:
  • How a connector appears to your tenants
  • How you and your tenants authenticate to the connector
  • The underling taps and targets that your connector uses

​
Example Connector Settings

    {
        "id": "shopify",
        "label": "Shopify",
        "type": "api",
        "tags": [
            "ecommerce",
            "featured"
        ],
        "icon": "https://s3.amazonaws.com/cdn.hotglue.xyz/images/logos/shopify.svg",
        "domain": "shopify.com",
        "isConnector": true,
        "isSource": false,
        "isTarget": false,
        "read_connector": {
            "id": "shopify"
        },
        "write_connector": {
            "id": "shopify-v2",
            "install_uri": "git+https://gitlab.com/hotglue/target-shopify-v2.git@bump-to-use-new-target-sdk"
        },
        "connect_ui_params": {
            "api_key": {
                "label": "API Password",
                "description": "Shopify API Password",
                "type": "password"
            },
            "api_key_id": {
                "label": "API Key",
                "description": "Shopify API Key",
                "type": "password",
                "required": false
            },
            "shop": {
                "label": "Shop",
                "description": "Shopify shop name (ie. the value test_shop in the string https://test_shop.myshopify.com)",
                "adornment": {
                    "start": "https://",
                    "end": ".myshopify.com"
                }
            },
            "bulk": {
                "type": "boolean",
                "label": "Bulk",
                "required": false
            }
        },
        "options": {
            "auto_support": true,
            "has_triggers": true,
            "validation_supported": true,
            "available_triggers": [
                {
                    "id": "orders/create",
                    "name": "Created order",
                    "description": "Triggered when a new sale order is created"
                },
                {
                    "id": "orders/delete",
                    "name": "Deleted order",
                    "description": "Triggered when a sale order is deleted"
                },
                {
                    "id": "products/create",
                    "name": "Created product",
                    "description": "Triggered when a new product is created"
                },
                {
                    "id": "products/delete",
                    "name": "Deleted product",
                    "description": "Triggered when a product is deleted"
                }
            ],
            "config": {
                "start_date": "2015-01-01T00:00:00.000Z",
                "date_window_size": 365
            },
            "schemaTables": [
                "SalesOrders"
            ],
            "hg_schema": "ecommerce"
        },
        "isForked": true
    }

​
Understanding the Connector Fields

​
id

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

​
label

The label field is a human-readable name for the connector. 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 connector. This icon will be displayed in the user interface alongside the connector’s label.

​
tags

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

​
domain

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

​
type

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

​
read_connector and write_connector

These fields specify the github repo of the tap and target respectively. If a connector uses Hotglue’s default tap or target, you can set just an id: 
"read_connector": {
    "id": "shopify"
}
If the connector uses a custom branch of a git repo, you can set a custom install uri: 
"write_connector": {
    "id": "shopify-v2",
    "install_uri": "git+https://gitlab.com/hotglue/target-shopify-v2.git@bump-to-use-new-target-sdk"
},
If that repository is private, you can add the is_private_repo flag to use your configured git access token when installing your connector. 
"write_connector": {
    "id": "shopify-v2",
    "install_uri": "git+https://gitlab.com/hotglue/target-shopify-v2.git@bump-to-use-new-target-sdk"
    "is_private_repo": true
},
If the connector uses a tagged release of a repository, you can specify that connector tag: 
    "connector_repo": "git+https://github.com/hotgluexyz/target-redshift.git",
    "connector_tag": "^v1.6.1",
    "singer_sdk": true

​
isForked

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

​
formattable_fields

The formattable_fields flag allows you to set a list of config flags that can be used as variables for your auth URLs. 
"formattable_fields": ["shop", "tenant_id"]
For example, if you set: 
"auth_url": "https://{shop}.shopify.com/token"
And the tenant has config: 
{
  ...
  "shop": "usa",
  ...
}
then hotglue will use the following auth_url when completing the OAuth flow: 
https://usa.shopify.com/token
All fields specified in the connect_ui_params are used as formattable_fields by default.
⌘I