Insightly account details

To establish a connection to Insightly, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters

You can define one or more accounts for Insightly.

For each account that you require, you can specify a new set of account details in any of the following ways:

  • If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
  • If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

Field Parameter Values Condition Description

Account name

name

User defined

Required

The name of a Insightly account that is used in the exported flow.

API key

apiKey

User defined

Required

The API key used to authenticate when making API calls, and which establishes the access permissions that are allowed.

You can locate this value under User Settings in the Insightly UI. For more information, see Finding your API key or URL and resetting your key in the Insightly Help Center.

API version

version

v3.1

Required

The version of the Insightly API that should be used to query and update data in your Insightly instance. App Connect supports version 3.1 of the API.

Example

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

  insightly:
    - name: Account 1
      credentials:
        apiKey: 91234a56-62c0-4c7d-80df-625tt76e99ef
        version: v3.1
      endpoint: {}