Member Junction
    Preparing search index...

    Interface IntegrationObjectInfo

    Simplified representation of an integration object for generation

    interface IntegrationObjectInfo {
        Description?: string;
        DisplayName: string;
        Fields: IntegrationFieldInfo[];
        IncludeInActionGeneration?: boolean;
        Name: string;
        SupportsWrite: boolean;
        UpsertKey?: string;
    }
    Index

    Properties

    Description? DisplayName Fields IncludeInActionGeneration? Name SupportsWrite UpsertKey?

    Properties

    Description?: string

    Object description

    DisplayName: string

    Human-readable display name (e.g., "Contacts", "Deals")

    Fields: IntegrationFieldInfo[]

    Fields on this object

    IncludeInActionGeneration?: boolean

    Whether to include this object in action generation. Defaults to true. Set to false for objects that should be available for API property lookups but don't suit generic CRUD action patterns (e.g., activity objects).

    Name: string

    Object name in the external system (e.g., "contacts", "deals")

    SupportsWrite: boolean

    Whether the connector supports writing to this object

    UpsertKey?: string

    The unique business property to upsert this object by (e.g. 'email' for HubSpot contacts). When set, the connector's Upsert verb defaults to keying on this property. Optional — objects without a natural upsert key omit it.

    Settings

    Member Visibility

    On This Page

    Properties