Interface ElementInstanceFields

Optionaluser?: {
    id: string;
    name: string;
    meta?: Record<string, any>;
    internalId: string;
    fields?: Record<string, any>;
    credentials?: any;
    lastActiveAt?: string;
    isTest?: boolean;
    isBillable?: boolean;
    isActive?: boolean;
    aiCreditsRolling30DayLimit?: number | null;
    createdAt?: string;
    archivedAt?: string;
}

Optionalintegration?: {
    logoUri: string;
    connectorId?: string;
    connectorVersion?: string;
    oAuthCallbackUri?: string;
    parameters?: any;
    archivedAt?: string;
    hasMissingParameters?: boolean;
    hasDocumentation?: boolean;
    hasOperations?: boolean;
    operationsCount?: number;
    hasData?: boolean;
    dataCollectionsCount?: number;
    hasEvents?: boolean;
    eventsCount?: number;
    hasGlobalWebhooks?: boolean;
    hasUdm?: boolean;
    isTest?: boolean;
    externalAppId?: string;
    appUuid?: string;
    isDeactivated?: boolean;
    authType?:
        | "proxy"
        | "integration-app-token"
        | "membrane-token"
        | "oauth2"
        | "oauth1"
        | "client-credentials";
    optionsConfig?: Record<
        string,
        { disabled?: boolean; parameters?: Record<string, any> },
    >;
    id: string;
    uuid?: string;
    key?: string;
    description?: string;
    meta?: Record<string, any>;
    name: string;
    state?:
        | BUILDING
        | CLIENT_ACTION_REQUIRED
        | CONFIGURATION_ERROR
        | SETUP_FAILED
        | READY
        | DISCONNECTING;
    errors?: ErrorDataSchema[];
    revision?: string;
    createdAt?: string;
    updatedAt?: string;
    isReadOnly?: boolean;
}

• logoUri: string

  Publicly accessible logo of the integrated app.

• OptionalconnectorId?: string

• OptionalconnectorVersion?: string

• OptionaloAuthCallbackUri?: string

• Optionalparameters?: any

• OptionalarchivedAt?: string

• OptionalhasMissingParameters?: boolean

• OptionalhasDocumentation?: boolean

• OptionalhasOperations?: boolean

• OptionaloperationsCount?: number

• OptionalhasData?: boolean

• OptionaldataCollectionsCount?: number

• OptionalhasEvents?: boolean

• OptionaleventsCount?: number

• OptionalhasGlobalWebhooks?: boolean

• OptionalhasUdm?: boolean

• OptionalisTest?: boolean

• OptionalexternalAppId?: string

• OptionalappUuid?: string

  Deprecated

  Use externalAppId instead

• OptionalisDeactivated?: boolean

• OptionalauthType?:
      | "proxy"
      | "integration-app-token"
      | "membrane-token"
      | "oauth2"
      | "oauth1"
      | "client-credentials"

  Deprecated

  • use authOptions instead

• OptionaloptionsConfig?: Record<string, { disabled?: boolean; parameters?: Record<string, any> }>

  Per-auth-option configuration. Only returned with includeSecrets=true.

• id: string

• Optionaluuid?: string

• Optionalkey?: string

• Optionaldescription?: string

• Optionalmeta?: Record<string, any>

• name: string

• Optionalstate?:
      | BUILDING
      | CLIENT_ACTION_REQUIRED
      | CONFIGURATION_ERROR
      | SETUP_FAILED
      | READY
      | DISCONNECTING

• Optionalerrors?: ErrorDataSchema[]

• Optionalrevision?: string

• OptionalcreatedAt?: string

• OptionalupdatedAt?: string

• OptionalisReadOnly?: boolean

OptionalconnectorParameters?: unknown

Optionalinput?: unknown

Optionaltype?: "connector" | "mcp"

name: string

Optionalkey?: string

OptionalisTest?: boolean

Optionalconnected?: boolean

Optionaldisconnected?: boolean

OptionalisDefunct?: boolean

Optionalstate?:
    | BUILDING
    | CLIENT_ACTION_REQUIRED
    | CONFIGURATION_ERROR
    | SETUP_FAILED
    | READY
    | DISCONNECTING

Optionalerrors?: ErrorDataSchema[]

OptionalrequestError?: ErrorDataSchema

Optionalerror?: ErrorDataSchema

OptionalintegrationId?: string

OptionalconnectorId?: string

OptionalexternalAppId?: string

OptionalconnectorVersion?: string

OptionalauthOptionKey?: string

createdAt: string

updatedAt: string

OptionallastActiveAt?: string

OptionalnextCredentialsRefreshAt?: string

OptionalnextRetryTimestamp?: string

OptionalretryAttempts?: number

OptionalcanTest?: boolean

OptionalcanRefreshCredentials?: boolean

OptionalarchivedAt?: string

OptionalisDeactivated?: boolean

Optionalmeta?: Record<string, any>

OptionalbuildingAgentSessionId?: string

OptionalclientAction?: {
    type: "connect" | "provide-input";
    description: string;
    uiUrl?: string;
    agentInstructions?: string;
    handoffAgentInstructions?: string;
    reason?: "provide-input" | "authenticate" | "reauthenticate";
}

id: string

userId: string

OptionaltenantId?: string

Optionalconnection?: {
    type?: "connector" | "mcp";
    name: string;
    key?: string;
    isTest?: boolean;
    connected?: boolean;
    disconnected?: boolean;
    isDefunct?: boolean;
    state?:
        | BUILDING
        | CLIENT_ACTION_REQUIRED
        | CONFIGURATION_ERROR
        | SETUP_FAILED
        | READY
        | DISCONNECTING;
    errors?: ErrorDataSchema[];
    requestError?: ErrorDataSchema;
    error?: ErrorDataSchema;
    integrationId?: string;
    connectorId?: string;
    externalAppId?: string;
    connectorVersion?: string;
    authOptionKey?: string;
    createdAt: string;
    updatedAt: string;
    lastActiveAt?: string;
    nextCredentialsRefreshAt?: string;
    nextRetryTimestamp?: string;
    retryAttempts?: number;
    canTest?: boolean;
    canRefreshCredentials?: boolean;
    archivedAt?: string;
    isDeactivated?: boolean;
    meta?: Record<string, any>;
    buildingAgentSessionId?: string;
    clientAction?: {
        type: "connect" | "provide-input";
        description: string;
        uiUrl?: string;
        agentInstructions?: string;
        handoffAgentInstructions?: string;
        reason?: "provide-input" | "authenticate" | "reauthenticate";
    };
    id: string;
    userId: string;
    tenantId?: string;
}

• Optionaltype?: "connector" | "mcp"

  Discriminator for what backs the connection. Undefined = legacy connector-backed. 'mcp' connections have no connectorId and target an arbitrary MCP server URL.

• name: string

  User-readable name of the connection

• Optionalkey?: string

  Stable, human-readable key for addressing this connection. Unique per tenant. Matches the convention used for all workspace element keys.

• OptionalisTest?: boolean

• Optionalconnected?: boolean

  Whether the connection has been successfully authenticated and verified.

• Optionaldisconnected?: boolean

  Deprecated

  Use connected instead.

• OptionalisDefunct?: boolean

  Deprecated

  • use isDeactivated instead

• Optionalstate?:
      | BUILDING
      | CLIENT_ACTION_REQUIRED
      | CONFIGURATION_ERROR
      | SETUP_FAILED
      | READY
      | DISCONNECTING

• Optionalerrors?: ErrorDataSchema[]

  Validation or setup errors when state is not READY.

• OptionalrequestError?: ErrorDataSchema

  Last error from a runtime operation (credential refresh, connection test, API call). Cleared when the operation succeeds.

• Optionalerror?: ErrorDataSchema

  Deprecated

  Use requestError and errors instead.

• OptionalintegrationId?: string

  Id of an integration the connection is created with. Optional if connectorId is provided.

• OptionalconnectorId?: string

  Id of a connector the connection is created with. Used for direct connector-based connections (without an integration).

• OptionalexternalAppId?: string

  Id of an external app linked to this connection.

• OptionalconnectorVersion?: string

  Version of the connector to use. Only applicable when connectorId is set.

• OptionalauthOptionKey?: string

• createdAt: string

• updatedAt: string

• OptionallastActiveAt?: string

  Timestamp when the connection was last active

• OptionalnextCredentialsRefreshAt?: string

  Timestamp when the connection credentials should be refreshed

• OptionalnextRetryTimestamp?: string

  Timestamp when the next connection retry should be attempted

• OptionalretryAttempts?: number

  Number of retry attempts made for this connection

• OptionalcanTest?: boolean

  Whether the connection can be tested

• OptionalcanRefreshCredentials?: boolean

  Whether the connection credentials can be refreshed

• OptionalarchivedAt?: string

• OptionalisDeactivated?: boolean

• Optionalmeta?: Record<string, any>

• OptionalbuildingAgentSessionId?: string

• OptionalclientAction?: {
      type: "connect" | "provide-input";
      description: string;
      uiUrl?: string;
      agentInstructions?: string;
      handoffAgentInstructions?: string;
      reason?: "provide-input" | "authenticate" | "reauthenticate";
  }

• id: string

• userId: string

• OptionaltenantId?: string

Optionalspec?: any

OptionalauthOptions?: {
    key: string;
    type:
        | "proxy"
        | "integration-app-token"
        | "membrane-token"
        | "oauth2"
        | "oauth1"
        | "client-credentials";
    title?: string;
    description?: string;
    inputSchema?: DataSchema;
    ui?: { schema?: any; helpUri?: string };
}[]

Optionalid?: string

OptionallogoUri?: string

OptionalappUri?: string

OptionalisConnected?: boolean

OptionalconnectorId?: string

OptionalconnectorVersion?: string

OptionaloAuthCallbackUri?: string

Optionalparameters?: any

OptionalarchivedAt?: string

OptionalhasMissingParameters?: boolean

OptionalhasDocumentation?: boolean

OptionalhasOperations?: boolean

OptionaloperationsCount?: number

OptionalhasData?: boolean

OptionaldataCollectionsCount?: number

OptionalhasEvents?: boolean

OptionaleventsCount?: number

OptionalhasGlobalWebhooks?: boolean

OptionalhasUdm?: boolean

OptionalisTest?: boolean

OptionalexternalAppId?: string

OptionalappUuid?: string

OptionalisDeactivated?: boolean

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

OptionaloptionsConfig?: Record<string, { disabled?: boolean; parameters?: Record<string, any> }>

Optionaluuid?: string

Optionalkey?: string

Optionaldescription?: string

Optionalmeta?: Record<string, any>

name: string

Optionalstate?:
    | BUILDING
    | CLIENT_ACTION_REQUIRED
    | CONFIGURATION_ERROR
    | SETUP_FAILED
    | READY
    | DISCONNECTING

Optionalerrors?: ErrorDataSchema[]

Optionalrevision?: string

OptionalcreatedAt?: string

OptionalupdatedAt?: string

OptionalisReadOnly?: boolean