Hubspot¶

Node: hubspot · Full type: n8n-nodes-base.hubspot · Version: 2.2

Credentials¶

hubspotApi (alias: @hubspot) / hubspotAppToken (alias: @hubspot) / hubspotOAuth2Api (alias: @hubspot)

CREDENTIAL @hubspot = hubspotApi "My Hubspot"

Operations¶

Resource: `company`¶

`create`¶

Parameter	Type	Default	Details
`name`	string	""	required
`additionalFields`	collection	{}	keys: `aboutUs`, `annualRevenue`, `city`, `closeDate`, `companyDomainName`, `companyOwner`, ...

`delete`¶

Parameter	Type	Default	Details
`companyId`	resourceLocator	{...}	required; modes: `list`, `id`

`get`¶

Parameter	Type	Default	Details
`companyId`	resourceLocator	{...}	required; modes: `list`, `id`
`additionalFields`	collection	{}	keys: `includeMergeAudits`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`options`	collection	{}	keys: `includeMergeAudits`, `propertiesCollection`

`getRecentlyCreatedUpdated`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`additionalFields`	collection	{}	keys: `since`, `propertiesCollection`

`searchByDomain`¶

Parameter	Type	Default	Details
`domain`	string	""	required
`returnAll`	boolean	false
`limit`	number	100
`options`	collection	{}	keys: `properties`

`update`¶

Parameter	Type	Default	Details
`companyId`	resourceLocator	{...}	required; modes: `list`, `id`
`updateFields`	collection	{}	keys: `aboutUs`, `annualRevenue`, `city`, `closeDate`, `companyDomainName`, `companyOwner`, ...

Resource: `contact`¶

`upsert`¶

Parameter	Type	Default	Details
`email`	string	""	required
`additionalFields`	collection	{}	keys: `annualRevenue`, `associatedCompanyId`, `buyingRole`, `city`, `clickedFacebookAd`, `closeDate`, ...
`options`	collection	{}	keys: `resolveData`

`delete`¶

Parameter	Type	Default	Details
`contactId`	resourceLocator	{...}	required; modes: `list`, `id`

`get`¶

Parameter	Type	Default	Details
`contactId`	resourceLocator	{...}	required; modes: `list`, `id`
`additionalFields`	collection	{}	keys: `formSubmissionMode`, `listMemberships`, `propertiesCollection`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`additionalFields`	collection	{}	keys: `formSubmissionMode`, `listMemberships`, `propertiesCollection`

`getRecentlyCreatedUpdated`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`additionalFields`	collection	{}	keys: `formSubmissionMode`, `listMemberships`, `propertiesCollection`

`search`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filterGroupsUi`	fixedCollection	{}	groups: `filterGroupsValues`
`additionalFields`	collection	{}	keys: `direction`, `properties`, `query`, `sortBy`

Resource: `contactList`¶

`add`¶

Parameter	Type	Default	Details
`by`	options	"email"	required; `id`, `email`
`email`	string	""	required
`id`	number	""	required
`listId`	number	""	required

`remove`¶

Parameter	Type	Default	Details
`id`	number	""	required
`listId`	number	""	required

Resource: `deal`¶

`create`¶

Parameter	Type	Default	Details
`stage`	options	""	required
`additionalFields`	collection	{}	keys: `amount`, `associatedCompany`, `associatedVids`, `closeDate`, `customPropertiesUi`, `description`, ...

`delete`¶

Parameter	Type	Default	Details
`dealId`	resourceLocator	{...}	required; modes: `list`, `id`

`get`¶

Parameter	Type	Default	Details
`dealId`	resourceLocator	{...}	required; modes: `list`, `id`
`filters`	collection	{}	keys: `includePropertyVersions`, `propertiesCollection`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `includeAssociations`, `properties`, `propertiesWithHistory`, `propertiesCollection`

`getRecentlyCreatedUpdated`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filters`	collection	{}	keys: `since`, `includePropertyVersions`

`search`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`filterGroupsUi`	fixedCollection	{}	groups: `filterGroupsValues`
`additionalFields`	collection	{}	keys: `direction`, `properties`, `query`, `sortBy`

`update`¶

Parameter	Type	Default	Details
`dealId`	resourceLocator	{...}	required; modes: `list`, `id`
`updateFields`	collection	{}	keys: `amount`, `closeDate`, `customPropertiesUi`, `description`, `dealName`, `dealOwner`, ...

Resource: `engagement`¶

`create`¶

Parameter	Type	Default	Details
`type`	options	""	required; `call`, `email`, `meeting`, `task`
`dueDate`	dateTime	""	required
`metadata`	collection	{}	keys: `body`, `forObjectType`, `status`, `subject`
`metadata`	collection	{}	keys: `bcc`, `cc`, `fromEmail`, `firstName`, `lastName`, `html`, ...
`metadata`	collection	{}	keys: `body`, `endTime`, `internalMeetingNotes`, `startTime`, `title`
`metadata`	collection	{}	keys: `body`, `durationMilliseconds`, `fromNumber`, `recordingUrl`, `status`, `toNumber`
`additionalFields`	collection	{}	keys: `associations`

`delete`¶

Parameter	Type	Default	Details
`engagementId`	resourceLocator	{...}	required; modes: `list`, `id`

`get`¶

Parameter	Type	Default	Details
`engagementId`	resourceLocator	{...}	required; modes: `list`, `id`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100

Resource: `ticket`¶

`create`¶

Parameter	Type	Default	Details
`pipelineId`	options	""	required
`stageId`	options	""	required
`ticketName`	string	""	required
`additionalFields`	collection	{}	keys: `associatedCompanyIds`, `associatedContactIds`, `category`, `closeDate`, `createDate`, `description`, ...

`delete`¶

Parameter	Type	Default	Details
`ticketId`	resourceLocator	{...}	required; modes: `list`, `id`

`get`¶

Parameter	Type	Default	Details
`ticketId`	resourceLocator	{...}	required; modes: `list`, `id`
`additionalFields`	collection	{}	keys: `includeDeleted`, `properties`, `propertiesWithHistory`

`getAll`¶

Parameter	Type	Default	Details
`returnAll`	boolean	false
`limit`	number	100
`additionalFields`	collection	{}	keys: `properties`, `propertiesWithHistory`

`update`¶

Parameter	Type	Default	Details
`ticketId`	resourceLocator	{...}	required; modes: `list`, `id`
`updateFields`	collection	{}	keys: `associatedCompanyIds`, `associatedContactIds`, `category`, `closeDate`, `createDate`, `description`, ...

Common Parameters¶

Parameter	Type	Default	Details
`authentication`	options	"apiKey"	`apiKey`, `appToken`, `oAuth2`

Parameter Details¶

additionalFields children:

Parameter	Type	Default	Details
`annualRevenue`	number	0
`associatedCompanyId`	options	""
`buyingRole`	multiOptions	[]	multi: `BLOCKER`, `BUDGET_HOLDER`, `CHAMPION`, `DECISION_MAKER`, `END_USER`, `EXECUTIVE_SPONSOR`, `INFLUENCER`, `LEGAL_AND_COMPLIANCE`, ... (9 total)
`city`	string	""
`clickedFacebookAd`	string	""
`closeDate`	dateTime	""
`companyName`	string	""
`companySize`	string	""
`contactOwner`	options	""
`properties`	multiOptions	[]
`country`	string	""
`countryRegionCode`	string	""
`customPropertiesUi`	fixedCollection	{}	groups: `customPropertiesValues`
`dateOfBirth`	dateTime	""
`degree`	string	""
`emailCustomerQuarantinedReason`	options	""	`SUSPENSION_REMEDIATION`, `BLOCKLIST_REMEDIATION`, `TRUST_SAFETY_REMEDIATION`
`employmentRole`	options	""	`accounting`, `administrative`, `business_development`, `communications`, `consulting`, `customer_service`, `design`, `education`, ... (27 total)
`employmentSeniority`	options	""	`director`, `employee`, `entry`, `executive`, `manager`, `owner`, `partner`, `senior`, ... (9 total)
`employmentSubRole`	options	""	`account_executive`, `account_manager`, `accountant`, `accounting_manager`, `administrative_assistant`, `appraisal`, `architect_it`, `assistant`, ... (128 total)
`enrichedEmailBounceDetected`	boolean	false
`facebookClickId`	number	""
`faxNumber`	string	""
`fieldOfStudy`	string	""
`firstName`	string	""
`gender`	string	""
`googleAdClickId`	number	""
`graduationDate`	dateTime	""
`industry`	string	""
`inferredLanguageCodes`	options	""	`ab`, `aa`, `af`, `ak`, `sq`, `am`, `ar`, `an`, ... (183 total)
`jobFunction`	string	""
`jobTitle`	string	""
`lastName`	string	""
`latestTrafficSource`	options	""	`DIRECT_TRAFFIC`, `EMAIL_MARKETING`, `OFFLINE`, `ORGANIC_SEARCH`, `SOCIAL_MEDIA`, `OTHER_CAMPAIGNS`, `PAID_SEARCH`, `PAID_SOCIAL`, ... (9 total)
`latestTrafficSourceDate`	dateTime	""
`leadStatus`	options	""
`processingContactData`	options	""
`lifeCycleStage`	options	""
`linkedinUrl`	string	""
`maritalStatus`	string	""
`memberEmail`	string	""
`membershipNote`	string	""
`message`	string	""
`militaryStatus`	string	""
`mobilePhoneNumber`	string	""
`numberOfEmployees`	options	""
`originalSource`	options	""
`persona`	string	""
`phoneNumber`	string	""
`postalCode`	string	""
`prefferedLanguage`	options	""
`prospectingAgentLastEnrolled`	dateTime	""
`prospectingAgentTotalEnrolledCount`	number	""
`relationshipStatus`	string	""
`salutation`	string	""
`school`	string	""
`seniority`	string	""
`startDate`	dateTime	""
`stateRegion`	string	""
`stateRegionCode`	string	""
`status`	options	""
`streetAddress`	string	""
`timeZone`	options	""	`atlantic_slash_cape_verde`, `america_slash_godthab`, `america_slash_miquelon`, `america_slash_noronha`, `atlantic_slash_south_georgia`, `brazil_slash_denoronha`, `america_slash_st_johns`, `canada_slash_newfoundland`, ... (525 total)
`twitterUsername`	string	""
`websiteUrl`	string	""
`whatsappPhoneNumber`	string	""
`workEmail`	string	""

options children:

Parameter	Type	Default	Details
`resolveData`	boolean	false

filterGroupsUi children:

filterGroupsValues group:

Parameter	Type	Default	Details
`filtersUi`	fixedCollection	{}	groups: `filterValues`

updateFields children:

Parameter	Type	Default	Details
`aboutUs`	string	""
`annualRevenue`	number	0
`city`	string	""
`closeDate`	dateTime	""
`companyDomainName`	string	""
`companyOwner`	options	""
`countryRegion`	string	""
`customPropertiesUi`	fixedCollection	{}	groups: `customPropertiesValues`
`description`	string	""
`facebookFans`	number	0
`googlePlusPage`	string	""
`industry`	options	""
`isPublic`	boolean	false
`leadStatus`	options	""
`lifecycleStatus`	options	""
`linkedinBio`	string	""
`linkedInCompanyPage`	string	""
`name`	string	""
`numberOfEmployees`	number	0
`originalSourceType`	options	""
`phoneNumber`	string	""
`postalCode`	string	""
`stateRegion`	string	""
`streetAddress`	string	""
`streetAddress2`	string	""
`targetAccount`	options	""
`timezone`	string	""
`totalMoneyRaised`	number	0
`twitterBio`	string	""
`twitterFollowers`	number	0
`twitterHandle`	string	""
`type`	options	""
`webTechnologies`	options	""
`websiteUrl`	string	""
`yearFounded`	string	""

filters children:

Parameter	Type	Default	Details
`includePropertyVersions`	boolean	false
`propertiesCollection`	fixedCollection	{}	groups: `propertiesValues`

metadata children:

Parameter	Type	Default	Details
`body`	string	""
`forObjectType`	options	""	`COMPANY`, `CONTACT`
`status`	options	""	`COMPLETED`, `DEFERRED`, `IN_PROGRESS`, `NOT_STARTED`, `WAITING`
`subject`	string	""

Example¶

NODE "hubspot" @hubspot AS "Hubspot" {
  resource: "company",
  operation: "get",
  email: {{ $json.email }},
  id: 0,
  listId: 0
}

Hubspot¶

Credentials¶

Operations¶

Resource: company¶

create¶

delete¶

get¶

getAll¶

getRecentlyCreatedUpdated¶

searchByDomain¶

update¶

Resource: contact¶

upsert¶

delete¶

get¶

getAll¶

getRecentlyCreatedUpdated¶

search¶

Resource: contactList¶

add¶

remove¶

Resource: deal¶

create¶

delete¶

get¶

getAll¶

getRecentlyCreatedUpdated¶

search¶

update¶

Resource: engagement¶

create¶

delete¶

get¶

getAll¶

Resource: ticket¶

create¶

delete¶

get¶

getAll¶

update¶

Common Parameters¶

Parameter Details¶

Example¶

Resource: `company`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getRecentlyCreatedUpdated`¶

`searchByDomain`¶

`update`¶

Resource: `contact`¶

`upsert`¶

`delete`¶

`get`¶

`getAll`¶

`getRecentlyCreatedUpdated`¶

`search`¶

Resource: `contactList`¶

`add`¶

`remove`¶

Resource: `deal`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`getRecentlyCreatedUpdated`¶

`search`¶

`update`¶

Resource: `engagement`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

Resource: `ticket`¶

`create`¶

`delete`¶

`get`¶

`getAll`¶

`update`¶