Use the supported-entities commands to manage the connectors that tenants can link to a flow. The entity must already be available in the environment before it can be added to a flow.

Supported Entities Get

Description

Gets a supported entity and returns its connection parameters (connect_ui_params). Use this to discover the expected configuration before linking the entity to a tenant.

Samples

Get a v2 connector and its connection parameters:

hotglue supported-entities get --env prod.acme.com --flow bTHIweD0W --id shopify

Use --entity-type and --flow-version to get another supported entity type:

# v2 source
hotglue supported-entities get --env prod.acme.com --flow bTHIweD0W --id shopify --entity-type source

# v1 source
hotglue supported-entities get --env prod.acme.com --flow bTHIweD0W --id shopify --entity-type source --flow-version v1

Return machine-readable output for programmatic inspection:

hotglue supported-entities get --env prod.acme.com --flow bTHIweD0W --id s3 --json

Parameters

Option	Default	Description
`--apikey`, `-k`	Profile config	Personal API Key used to authenticate the request.
`--env`, `-e`		Required. Environment containing the flow.
`--flow`, `-f`		Required. Flow to get the supported entity from.
`--id`		Required. ID of an available connector, source, or target.
`--entity-type`	`connector`	Entity type. Must be `connector`, `source`, or `target`.
`--flow-version`	`v2`	Flow version. Must be `v1` or `v2`.
`--json`	`false`	Return machine-readable output.

Supported Entities Create

Description

Adds a supported entity to a flow. By default, the command adds a v2 connector. After creation, the command returns the created entity together with its connection parameters (connect_ui_params).

Samples

Add a v2 connector:

hotglue supported-entities create --env prod.acme.com --flow bTHIweD0W --id shopify

Pass connector configuration as a shell-quoted JSON object:

hotglue supported-entities create \
  --env prod.acme.com \
  --flow bTHIweD0W \
  --id shopify \
  --body '{"client_id":"client-id","client_secret":"client-secret"}'

Use --entity-type and --flow-version to add another supported entity type:

# v2 source
hotglue supported-entities create --env prod.acme.com --flow bTHIweD0W --id shopify --entity-type source

# v2 target with configuration
hotglue supported-entities create --env prod.acme.com --flow bTHIweD0W --id s3 --entity-type target --body '{"config":{"bucket":"my-bucket"}}'

# v1 source
hotglue supported-entities create --env prod.acme.com --flow bTHIweD0W --id shopify --entity-type source --flow-version v1

# v1 target
hotglue supported-entities create --env prod.acme.com --flow bTHIweD0W --id s3 --entity-type target --flow-version v1

V1 flows support sources and targets, but not connectors.

Parameters

Option	Default	Description
`--apikey`, `-k`	Profile config	Personal API Key used to authenticate the request.
`--env`, `-e`		Required. Environment containing the flow.
`--flow`, `-f`		Required. Flow to add the supported entity to.
`--id`		Required. ID of an available connector, source, or target.
`--body`	`{}`	Shell-quoted JSON object containing entity configuration. `--id` takes precedence over an identifier in this object.
`--entity-type`	`connector`	Entity type. Must be `connector`, `source`, or `target`.
`--flow-version`	`v2`	Flow version. Must be `v1` or `v2`.
`--json`	`false`	Return machine-readable output.

Getting Started

Key Concepts

Managed authentication

Transformation

Custom Connectors

Composite MCP

Unified Schema

Environment Settings

CLI

Connectors

Supported Entities

Supported Entities Get

Description

Samples

Parameters

Supported Entities Create

Description

Samples

Parameters

​Supported Entities Get

​Description

​Samples

​Parameters

​Supported Entities Create

​Description

​Samples

​Parameters

Supported Entities Get

Description

Samples

Parameters

Supported Entities Create

Description

Samples

Parameters