IntegrationDto

The Integrations API is intended for use by ProjectManager and its business
development partners. Please contact ProjectManager's sales team to request use of this API.

Fields

FieldDescription
id
uuid
required
The unique identifier of this Integration
name
string
optional
The friendly name of this Integration
description
string
optional
A description of this Integration that can be shared with users
shortId
string
optional
A short ID that uniquely identifies this Integration
isMultiInstance
boolean
required
True if this Integration allows multiple Instances.

An example of a multi-Instance Integration is one that can be connected to many
different folders or channels within a remote application.
config
object
optional
Extra configuration metadata for this Instance.
licenseSkus
string
optional
The list of SKUS for this Integration.
instances
IntegrationInstanceDto
optional
For multi-Instance Integrations, this contains the list of IntegrationInstances.
enabled
boolean
required
True if this Integration is enabled for the current Workspace.
authenticated
boolean
required
True if the user has authenticated
autoEnabled
boolean
required
True if the integration is auto-enabled