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
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:
is_private_repo
flag to use your configured git access token when installing your connector.
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.
auth_url
when completing the OAuth flow:
connect_ui_params
are used as formattable_fields
by default.