@squidcloud/client
    Preparing search index...

    Class ConnectorClient

    ConnectorClient manages app-level (integration-less) connectors attached to an application.

    Unlike integrations, these connectors carry no per-connector configuration record — attaching one simply adds it to the application's appConnectors list and (re)deploys its bundle. Any configuration the connector needs is provided out of band (e.g. via application secrets).

    Index

    Methods

    connect disconnect list

    Methods

    • Attaches a connector to the application. Idempotent — attaching an already-attached connector is a no-op on the platform side.

      Parameters

      • connectorId:
            | "confluence"
            | "github"
            | "google_calendar"
            | "google_drive"
            | "hubspot"
            | "jira"
            | "jira_jsm"
            | "linear"
            | "onedrive"
            | "salesforce"
            | "zendesk"
            | "servicenow_csm"
            | "freshdesk"
            | "mail"
            | "slack"
            | "teams"
            | "sharepoint"
            | "cotomi"
            | "essentials"
            | "ticketmind_companion"

        The id of the connector to attach.

      Returns Promise<void>

    • Detaches a connector from the application.

      Parameters

      • connectorId:
            | "confluence"
            | "github"
            | "google_calendar"
            | "google_drive"
            | "hubspot"
            | "jira"
            | "jira_jsm"
            | "linear"
            | "onedrive"
            | "salesforce"
            | "zendesk"
            | "servicenow_csm"
            | "freshdesk"
            | "mail"
            | "slack"
            | "teams"
            | "sharepoint"
            | "cotomi"
            | "essentials"
            | "ticketmind_companion"

        The id of the connector to detach.

      Returns Promise<void>

    • Lists the connectors explicitly attached to the application.

      Returns Promise<
          (
              | "confluence"
              | "github"
              | "google_calendar"
              | "google_drive"
              | "hubspot"
              | "jira"
              | "jira_jsm"
              | "linear"
              | "onedrive"
              | "salesforce"
              | "zendesk"
              | "servicenow_csm"
              | "freshdesk"
              | "mail"
              | "slack"
              | "teams"
              | "sharepoint"
              | "cotomi"
              | "essentials"
              | "ticketmind_companion"
          )[],
      >

      A promise that resolves with the list of attached connector ids.

    Settings

    Member Visibility

    On This Page

    Methods