Skip to main content

​
getSupportedConnectors

The getSupportedConnectors function provides information about all connectors supported in the environment, and whether they are linked by the configured tenant.

​
Parameters:

  • linkedConnectorsOnly: boolean
    • If true, returns only the connectors that are linked by the tenant.
  • flowIds: string[]
    • If set, only returns connectors in specific flows.

​
Returns:

A promise that resolves to an array of connector objects, each object contains:
  • id: string
  • flowId: string
  • label: string
  • icon: string
  • authenticationType: oauth | api
  • connectorType: source | target | connector
  • isLinked: boolean
  • availableEntity: Record<string, unknown>

​
Description

Returns all connectors in the environment and checks whether they are linked by the configured tenant.

​
Example (React):

const {
  getSupportedConnectors
} = useHotglue({
  tenantId: '...',
  environmentId: '...',
  apiKey: '...',
});

async function printSupportedConnectors() {
  const supportedConnectors = await getSupportedConnectors();
  console.log(supportedConnectors);
}