nodes/generated

Interface HubspotV1NodeParameters

Source
interface HubspotV1NodeParameters {
    additionalFields?:
        | {
            annualRevenue?: number;
            associatedCompanyId?: string;
            city?: string;
            clickedFacebookAd?: string;
            closeDate?: string;
            companyName?: string;
            companySize?: string;
            contactOwner?: string;
            country?: string;
            customPropertiesUi?: {
                customPropertiesValues: {
                    property?: string;
                    value?: string;
                }[];
            };
            dateOfBirth?: string;
            degree?: string;
            facebookClickId?: string;
            faxNumber?: string;
            fieldOfStudy?: string;
            firstName?: string;
            gender?: string;
            googleAdClickId?: string;
            graduationDate?: string;
            industry?: string;
            jobFunction?: string;
            jobTitle?: string;
            lastName?: string;
            leadStatus?: string;
            lifeCycleStage?: string;
            maritalStatus?: string;
            membershipNote?: string;
            message?: string;
            mobilePhoneNumber?: string;
            numberOfEmployees?: string;
            originalSource?: string;
            phoneNumber?: string;
            postalCode?: string;
            prefferedLanguage?: string;
            processingContactData?: string;
            properties?: unknown[];
            relationshipStatus?: string;
            salutation?: string;
            school?: string;
            seniority?: string;
            startDate?: string;
            stateRegion?: string;
            status?: string;
            streetAddress?: string;
            twitterUsername?: string;
            websiteUrl?: string;
            workEmail?: string;
        }
        | {
            formSubmissionMode?: | "all"
            | "none"
            | "newest"
            | "oldest";
            listMemberships?: boolean;
            properties?: unknown[];
            propertyMode?: "valueAndHistory"
            | "valueOnly";
        }
        | {
            direction?: "ASCENDING"
            | "DESCENDING";
            properties?: unknown[];
            query?: string;
            sortBy?: string;
        }
        | {
            aboutUs?: string;
            annualRevenue?: number;
            city?: string;
            closeDate?: string;
            companyDomainName?: string;
            companyOwner?: string;
            countryRegion?: string;
            customPropertiesUi?: {
                customPropertiesValues: {
                    property?: string;
                    value?: string;
                }[];
            };
            description?: string;
            facebookFans?: number;
            googlePlusPage?: string;
            industry?: string;
            isPublic?: boolean;
            leadStatus?: string;
            lifecycleStatus?: string;
            linkedinBio?: string;
            linkedInCompanyPage?: string;
            numberOfEmployees?: number;
            originalSourceType?: string;
            phoneNumber?: string;
            postalCode?: string;
            stateRegion?: string;
            streetAddress?: string;
            streetAddress2?: string;
            targetAccount?: string;
            timezone?: string;
            totalMoneyRaised?: number;
            twitterBio?: string;
            twitterFollowers?: number;
            twitterHandle?: string;
            type?: string;
            websiteUrl?: string;
            webTechnologies?: string;
            yearFounded?: string;
        }
        | { includeMergeAudits?: boolean }
        | {
            amount?: string;
            associatedCompany?: unknown[];
            associatedVids?: unknown[];
            closeDate?: string;
            customPropertiesUi?: {
                customPropertiesValues: {
                    property?: string;
                    value?: string;
                }[];
            };
            dealName?: string;
            dealType?: string;
            description?: string;
            pipeline?: string;
        }
        | { includePropertyVersions?: boolean }
        | {
            associations?: {
                companyIds?: string;
                contactIds?: string;
                dealIds?: string;
                ownerIds?: string;
                ticketIds?: string;
            };
        }
        | { skipValidation?: boolean; submittedAt?: string }
        | {
            associatedCompanyIds?: unknown[];
            associatedContactIds?: unknown[];
            category?: string;
            closeDate?: string;
            createDate?: string;
            description?: string;
            priority?: string;
            resolution?: string;
            source?: string;
            ticketOwnerId?: string;
        }
        | {
            includeDeleted?: boolean;
            properties?: unknown[];
            propertiesWithHistory?: string;
        }
        | {
            properties?: unknown[];
            propertiesWithHistory?: string;
        };
    authentication?: "apiKey"
    | "oAuth2"
    | "appToken";
    by?: "id" | "email";
    companyId?: string;
    contactId?: string;
    contextUi?: {
        contextValue: {
            goToWebinarWebinarKey?: string;
            hutk?: string;
            ipAddress?: string;
            pageId?: string;
            pageName?: string;
            pageUri?: string;
            sfdcCampaignId?: string;
        };
    };
    dealId?: string;
    domain?: string;
    email?: string;
    engagementId?: string;
    filterGroupsUi?: {
        filterGroupsValues: {
            filtersUi?: {
                filterValues: {
                    operator?: | "GT"
                    | "LT"
                    | "CONTAINS_TOKEN"
                    | "EQ"
                    | "GTE"
                    | "HAS_PROPERTY"
                    | "NOT_HAS_PROPERTY"
                    | "LTE"
                    | "NEQ";
                    propertyName?: string;
                    value?: string;
                }[];
            };
        }[];
    };
    filters?: | {
        formSubmissionMode?: | "all"
        | "none"
        | "newest"
        | "oldest";
        listMemberships?: boolean;
        properties?: unknown[];
        propertyMode?: "valueAndHistory"
        | "valueOnly";
    }
    | { includePropertyVersions?: boolean; since?: string }
    | {
        includeAssociations?: boolean;
        properties?: unknown[];
        propertiesWithHistory?: unknown[];
    };
    formId?: string;
    id?: string;
    lengalConsentUi?: {
        legitimateInterestValues: {
            legalBasis?: "CUSTOMER"
            | "LEAD";
            subscriptionTypeId?: string;
            text?: string;
            value?: boolean;
        };
        lengalConsentValues: {
            communicationsUi?: {
                communicationValues: {
                    subscriptionTypeId?: string;
                    text?: string;
                    value?: boolean;
                }[];
            };
            consentToProcess?: boolean;
            text?: string;
        };
    };
    limit?: number;
    listId?: string;
    metadata?: | {
        body?: string;
        forObjectType?: "COMPANY"
        | "CONTACT";
        status?:
            | "COMPLETED"
            | "IN_PROGRESS"
            | "DEFERRED"
            | "NOT_STARTED"
            | "WAITING";
        subject?: string;
    }
    | {
        bcc?: string;
        cc?: string;
        firstName?: string;
        fromEmail?: string;
        html?: string;
        lastName?: string;
        subject?: string;
        toEmail?: string;
    }
    | {
        body?: string;
        endTime?: string;
        internalMeetingNotes?: string;
        startTime?: string;
        title?: string;
    }
    | {
        body?: string;
        durationMilliseconds?: number;
        fromNumber?: string;
        recordingUrl?: string;
        status?: | "FAILED"
        | "COMPLETED"
        | "IN_PROGRESS"
        | "QUEUED"
        | "BUSY"
        | "CALLING_CRM_USER"
        | "CANCELED"
        | "CONNECTING"
        | "NO_ANSWER"
        | "RINGING";
        toNumber?: string;
    };
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "upsert"
    | "search"
    | "submit"
    | "getRecentlyCreatedUpdated"
    | "getRecentlyCreated"
    | "getRecentlyModified"
    | "searchByDomain"
    | "getFields";
    options?: | {
        includeMergeAudits?: boolean;
        properties?: unknown[];
        propertiesWithHistory?: string;
    }
    | { properties?: unknown[] };
    pipelineId?: string;
    resolveData?: boolean;
    resource?:
        | "contact"
        | "contactList"
        | "deal"
        | "company"
        | "form"
        | "ticket"
        | "engagement";
    returnAll?: boolean;
    stage?: string;
    stageId?: string;
    ticketId?: string;
    ticketName?: string;
    type?: "task"
    | "email"
    | "meeting"
    | "call";
    updateFields?:
        | {
            aboutUs?: string;
            annualRevenue?: number;
            city?: string;
            closeDate?: string;
            companyDomainName?: string;
            companyOwner?: string;
            countryRegion?: string;
            customPropertiesUi?: {
                customPropertiesValues: {
                    property?: string;
                    value?: string;
                }[];
            };
            description?: string;
            facebookFans?: number;
            googlePlusPage?: string;
            industry?: string;
            isPublic?: boolean;
            leadStatus?: string;
            lifecycleStatus?: string;
            linkedinBio?: string;
            linkedInCompanyPage?: string;
            name?: string;
            numberOfEmployees?: number;
            originalSourceType?: string;
            phoneNumber?: string;
            postalCode?: string;
            stateRegion?: string;
            streetAddress?: string;
            streetAddress2?: string;
            targetAccount?: string;
            timezone?: string;
            totalMoneyRaised?: number;
            twitterBio?: string;
            twitterFollowers?: number;
            twitterHandle?: string;
            type?: string;
            websiteUrl?: string;
            webTechnologies?: string;
            yearFounded?: string;
        }
        | {
            amount?: string;
            closeDate?: string;
            customPropertiesUi?: {
                customPropertiesValues: {
                    property?: string;
                    value?: string;
                }[];
            };
            dealName?: string;
            dealType?: string;
            description?: string;
            pipeline?: string;
            stage?: string;
        }
        | {
            associatedCompanyIds?: unknown[];
            associatedContactIds?: unknown[];
            category?: string;
            closeDate?: string;
            createDate?: string;
            description?: string;
            pipelineId?: string;
            priority?: string;
            resolution?: string;
            source?: string;
            stageId?: string;
            ticketName?: string;
            ticketOwnerId?: string;
        };
}

Properties§

Source§

readonly additionalFields?:
    | {
        annualRevenue?: number;
        associatedCompanyId?: string;
        city?: string;
        clickedFacebookAd?: string;
        closeDate?: string;
        companyName?: string;
        companySize?: string;
        contactOwner?: string;
        country?: string;
        customPropertiesUi?: {
            customPropertiesValues: {
                property?: string;
                value?: string;
            }[];
        };
        dateOfBirth?: string;
        degree?: string;
        facebookClickId?: string;
        faxNumber?: string;
        fieldOfStudy?: string;
        firstName?: string;
        gender?: string;
        googleAdClickId?: string;
        graduationDate?: string;
        industry?: string;
        jobFunction?: string;
        jobTitle?: string;
        lastName?: string;
        leadStatus?: string;
        lifeCycleStage?: string;
        maritalStatus?: string;
        membershipNote?: string;
        message?: string;
        mobilePhoneNumber?: string;
        numberOfEmployees?: string;
        originalSource?: string;
        phoneNumber?: string;
        postalCode?: string;
        prefferedLanguage?: string;
        processingContactData?: string;
        properties?: unknown[];
        relationshipStatus?: string;
        salutation?: string;
        school?: string;
        seniority?: string;
        startDate?: string;
        stateRegion?: string;
        status?: string;
        streetAddress?: string;
        twitterUsername?: string;
        websiteUrl?: string;
        workEmail?: string;
    }
    | {
        formSubmissionMode?: | "all"
        | "none"
        | "newest"
        | "oldest";
        listMemberships?: boolean;
        properties?: unknown[];
        propertyMode?: "valueAndHistory"
        | "valueOnly";
    }
    | {
        direction?: "ASCENDING"
        | "DESCENDING";
        properties?: unknown[];
        query?: string;
        sortBy?: string;
    }
    | {
        aboutUs?: string;
        annualRevenue?: number;
        city?: string;
        closeDate?: string;
        companyDomainName?: string;
        companyOwner?: string;
        countryRegion?: string;
        customPropertiesUi?: {
            customPropertiesValues: {
                property?: string;
                value?: string;
            }[];
        };
        description?: string;
        facebookFans?: number;
        googlePlusPage?: string;
        industry?: string;
        isPublic?: boolean;
        leadStatus?: string;
        lifecycleStatus?: string;
        linkedinBio?: string;
        linkedInCompanyPage?: string;
        numberOfEmployees?: number;
        originalSourceType?: string;
        phoneNumber?: string;
        postalCode?: string;
        stateRegion?: string;
        streetAddress?: string;
        streetAddress2?: string;
        targetAccount?: string;
        timezone?: string;
        totalMoneyRaised?: number;
        twitterBio?: string;
        twitterFollowers?: number;
        twitterHandle?: string;
        type?: string;
        websiteUrl?: string;
        webTechnologies?: string;
        yearFounded?: string;
    }
    | { includeMergeAudits?: boolean }
    | {
        amount?: string;
        associatedCompany?: unknown[];
        associatedVids?: unknown[];
        closeDate?: string;
        customPropertiesUi?: {
            customPropertiesValues: {
                property?: string;
                value?: string;
            }[];
        };
        dealName?: string;
        dealType?: string;
        description?: string;
        pipeline?: string;
    }
    | { includePropertyVersions?: boolean }
    | {
        associations?: {
            companyIds?: string;
            contactIds?: string;
            dealIds?: string;
            ownerIds?: string;
            ticketIds?: string;
        };
    }
    | { skipValidation?: boolean; submittedAt?: string }
    | {
        associatedCompanyIds?: unknown[];
        associatedContactIds?: unknown[];
        category?: string;
        closeDate?: string;
        createDate?: string;
        description?: string;
        priority?: string;
        resolution?: string;
        source?: string;
        ticketOwnerId?: string;
    }
    | {
        includeDeleted?: boolean;
        properties?: unknown[];
        propertiesWithHistory?: string;
    }
    | {
        properties?: unknown[];
        propertiesWithHistory?: string;
    }

Default: {}

Source§

readonly authentication?: "apiKey" | "oAuth2" | "appToken"

Default: "apiKey"

Source§

readonly by?: "id" | "email"

Default: "email"

Source§

readonly companyId?: string

Unique identifier for a particular company

Source§

readonly contactId?: string

Unique identifier for a particular contact

Source§

readonly contextUi?: {
    contextValue: {
        goToWebinarWebinarKey?: string;
        hutk?: string;
        ipAddress?: string;
        pageId?: string;
        pageName?: string;
        pageUri?: string;
        sfdcCampaignId?: string;
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly dealId?: string

Unique identifier for a particular deal

Source§

readonly domain?: string

The company's website domain to search for, like n8n.io

Source§

readonly email?: string

Source§

readonly engagementId?: string

Unique identifier for a particular engagement

Source§

readonly filterGroupsUi?: {
    filterGroupsValues: {
        filtersUi?: {
            filterValues: {
                operator?:
                    | "GT"
                    | "LT"
                    | "CONTAINS_TOKEN"
                    | "EQ"
                    | "GTE"
                    | "HAS_PROPERTY"
                    | "NOT_HAS_PROPERTY"
                    | "LTE"
                    | "NEQ";
                propertyName?: string;
                value?: string;
            }[];
        };
    }[];
}

When multiple filters are provided within a filterGroup, they will be combined using a logical AND operator. When multiple filterGroups are provided, they will be combined using a logical OR operator. The system supports a maximum of three filterGroups with up to three filters each. More info here Default: {} Type options: {"multipleValues":true}

Source§

readonly filters?:
    | {
        formSubmissionMode?: | "all"
        | "none"
        | "newest"
        | "oldest";
        listMemberships?: boolean;
        properties?: unknown[];
        propertyMode?: "valueAndHistory"
        | "valueOnly";
    }
    | { includePropertyVersions?: boolean; since?: string }
    | {
        includeAssociations?: boolean;
        properties?: unknown[];
        propertiesWithHistory?: unknown[];
    }

Default: {}

Source§

readonly formId?: string

The ID of the form you're sending data to. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getForms"}

Source§

readonly id?: string

Source§

readonly lengalConsentUi?: {
    legitimateInterestValues: {
        legalBasis?: "CUSTOMER" | "LEAD";
        subscriptionTypeId?: string;
        text?: string;
        value?: boolean;
    };
    lengalConsentValues: {
        communicationsUi?: {
            communicationValues: {
                subscriptionTypeId?: string;
                text?: string;
                value?: boolean;
            }[];
        };
        consentToProcess?: boolean;
        text?: string;
    };
}

Default: {} Type options: {"multipleValues":false}

Source§

readonly limit?: number

Max number of results to return Default: 100 Type options: {"minValue":1,"maxValue":250}

Source§

readonly listId?: string

Source§

readonly metadata?:
    | {
        body?: string;
        forObjectType?: "COMPANY"
        | "CONTACT";
        status?:
            | "COMPLETED"
            | "IN_PROGRESS"
            | "DEFERRED"
            | "NOT_STARTED"
            | "WAITING";
        subject?: string;
    }
    | {
        bcc?: string;
        cc?: string;
        firstName?: string;
        fromEmail?: string;
        html?: string;
        lastName?: string;
        subject?: string;
        toEmail?: string;
    }
    | {
        body?: string;
        endTime?: string;
        internalMeetingNotes?: string;
        startTime?: string;
        title?: string;
    }
    | {
        body?: string;
        durationMilliseconds?: number;
        fromNumber?: string;
        recordingUrl?: string;
        status?: | "FAILED"
        | "COMPLETED"
        | "IN_PROGRESS"
        | "QUEUED"
        | "BUSY"
        | "CALLING_CRM_USER"
        | "CANCELED"
        | "CONNECTING"
        | "NO_ANSWER"
        | "RINGING";
        toNumber?: string;
    }

Default: {}

Source§

readonly name?: string

Source§

readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "add"
    | "remove"
    | "delete"
    | "upsert"
    | "search"
    | "submit"
    | "getRecentlyCreatedUpdated"
    | "getRecentlyCreated"
    | "getRecentlyModified"
    | "searchByDomain"
    | "getFields"

Default: "upsert"

Source§

readonly options?:
    | {
        includeMergeAudits?: boolean;
        properties?: unknown[];
        propertiesWithHistory?: string;
    }
    | { properties?: unknown[] }

Default: {}

Source§

readonly pipelineId?: string

The ID of the pipeline the ticket is in. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getTicketPipelines"}

Source§

readonly resolveData?: boolean

By default the response only includes the ID. If this option gets activated, it will resolve the data automatically. Default: true

Source§

readonly resource?:
    | "contact"
    | "contactList"
    | "deal"
    | "company"
    | "form"
    | "ticket"
    | "engagement"

Default: "deal"

Source§

readonly returnAll?: boolean

Whether to return all results or only up to a given limit

Source§

readonly stage?: string

The dealstage is required when creating a deal. See the CRM Pipelines API for details on managing pipelines and stages. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getDealStages"}

Source§

readonly stageId?: string

The ID of the pipeline the ticket is in. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getTicketStages","loadOptionsDependsOn":["pipelineId"]}

Source§

readonly ticketId?: string

Unique identifier for a particular ticket

Source§

readonly ticketName?: string

The ID of the pipeline the ticket is in

Source§

readonly type?: "task" | "email" | "meeting" | "call"

Source§

readonly updateFields?:
    | {
        aboutUs?: string;
        annualRevenue?: number;
        city?: string;
        closeDate?: string;
        companyDomainName?: string;
        companyOwner?: string;
        countryRegion?: string;
        customPropertiesUi?: {
            customPropertiesValues: {
                property?: string;
                value?: string;
            }[];
        };
        description?: string;
        facebookFans?: number;
        googlePlusPage?: string;
        industry?: string;
        isPublic?: boolean;
        leadStatus?: string;
        lifecycleStatus?: string;
        linkedinBio?: string;
        linkedInCompanyPage?: string;
        name?: string;
        numberOfEmployees?: number;
        originalSourceType?: string;
        phoneNumber?: string;
        postalCode?: string;
        stateRegion?: string;
        streetAddress?: string;
        streetAddress2?: string;
        targetAccount?: string;
        timezone?: string;
        totalMoneyRaised?: number;
        twitterBio?: string;
        twitterFollowers?: number;
        twitterHandle?: string;
        type?: string;
        websiteUrl?: string;
        webTechnologies?: string;
        yearFounded?: string;
    }
    | {
        amount?: string;
        closeDate?: string;
        customPropertiesUi?: {
            customPropertiesValues: {
                property?: string;
                value?: string;
            }[];
        };
        dealName?: string;
        dealType?: string;
        description?: string;
        pipeline?: string;
        stage?: string;
    }
    | {
        associatedCompanyIds?: unknown[];
        associatedContactIds?: unknown[];
        category?: string;
        closeDate?: string;
        createDate?: string;
        description?: string;
        pipelineId?: string;
        priority?: string;
        resolution?: string;
        source?: string;
        stageId?: string;
        ticketName?: string;
        ticketOwnerId?: string;
    }

Default: {}