Interface Integration

interface Integration {
    id: string;
    name: string;
    key: string;
    state?: WorkspaceElementState;
    errors?: ErrorData[];
    logoUri: string;
    connectorId?: string;
    connectorVersion?: string;
    authOptions?: IntegrationAuthOption[];
    oAuthCallbackUri?: string;
    parametersSchema?: DataSchema;
    parameters?: any;
    baseUri: string;
    connection?: Connection;
    archivedAt?: string;
    areParametersCustomized?: boolean;
    spec?: ConnectorSpec;
    hasMissingParameters?: boolean;
    hasDefaultParameters?: boolean;
    hasDocumentation?: boolean;
    hasOperations?: boolean;
    hasData?: boolean;
    hasEvents?: boolean;
    hasGlobalWebhooks?: boolean;
    hasUdm?: boolean;
    isTest?: boolean;
    appUuid?: string;
    isDeactivated?: boolean;
    authType?:
        | "proxy"
        | "integration-app-token"
        | "oauth2"
        | "oauth1"
        | "client-credentials";
}

Properties

id name key state? errors? logoUri connectorId? connectorVersion? authOptions? oAuthCallbackUri? parametersSchema? parameters? baseUri connection? archivedAt? areParametersCustomized? spec? hasMissingParameters? hasDefaultParameters? hasDocumentation? hasOperations? hasData? hasEvents? hasGlobalWebhooks? hasUdm? isTest? appUuid? isDeactivated? authType?

Properties

id

id: string

name

name: string

key

key: string

Optionalstate

state?: WorkspaceElementState

Optionalerrors

errors?: ErrorData[]

logoUri

logoUri: string

Publicly accessible logo of the integrated app.

OptionalconnectorId

connectorId?: string

OptionalconnectorVersion

connectorVersion?: string

OptionalauthOptions

authOptions?: IntegrationAuthOption[]

OptionaloAuthCallbackUri

oAuthCallbackUri?: string

OptionalparametersSchema

parametersSchema?: DataSchema

Optionalparameters

parameters?: any

baseUri

baseUri: string

Where connector is stored

Optionalconnection

connection?: Connection

OptionalarchivedAt

archivedAt?: string

OptionalareParametersCustomized

areParametersCustomized?: boolean

Optionalspec

spec?: ConnectorSpec

OptionalhasMissingParameters

hasMissingParameters?: boolean

OptionalhasDefaultParameters

hasDefaultParameters?: boolean

OptionalhasDocumentation

hasDocumentation?: boolean

OptionalhasOperations

hasOperations?: boolean

OptionalhasData

hasData?: boolean

OptionalhasEvents

hasEvents?: boolean

OptionalhasGlobalWebhooks

hasGlobalWebhooks?: boolean

OptionalhasUdm

hasUdm?: boolean

OptionalisTest

isTest?: boolean

OptionalappUuid

appUuid?: string

OptionalisDeactivated

isDeactivated?: boolean

OptionalauthType

authType?:
    | "proxy"
    | "integration-app-token"
    | "oauth2"
    | "oauth1"
    | "client-credentials"

Deprecated

  • use authOptions instead

Settings

Member Visibility

On This Page

Properties