import { IExecuteFunctions, } from 'n8n-core'; import { IDataObject, INodeTypeDescription, INodeExecutionData, INodeType, ILoadOptionsFunctions, INodePropertyOptions, } from 'n8n-workflow'; import { hubspotApiRequest, hubspotApiRequestAllItems, } from './GenericFunctions'; import { dealOperations, dealFields, } from './DealDescription'; import { IDeal, IAssociation } from './DealInterface'; import { formOperations, formFields, } from './FormDescription'; import { IForm } from './FormInterface'; export class Hubspot implements INodeType { description: INodeTypeDescription = { displayName: 'Hubspot', name: 'hubspot', icon: 'file:hubspot.png', group: ['output'], version: 1, subtitle: '={{$parameter["operation"] + ": " + $parameter["resource"]}}', description: 'Consume Hubspot API', defaults: { name: 'Hubspot', color: '#ff7f64', }, inputs: ['main'], outputs: ['main'], credentials: [ { name: 'hubspotApi', required: true, } ], properties: [ { displayName: 'Resource', name: 'resource', type: 'options', options: [ { name: 'Deal', value: 'deal', }, { name: 'Form', value: 'form', }, ], default: 'deal', description: 'Resource to consume.', }, // Deal ...dealOperations, ...dealFields, // Form ...formOperations, ...formFields, ], }; methods = { loadOptions: { // Get all the groups to display them to user so that he can // select them easily async getDealStages(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/crm-pipelines/v1/pipelines/deals'; let stages = await hubspotApiRequest.call(this, 'GET', endpoint, {}); stages = stages.results[0].stages; for (const stage of stages) { const stageName = stage.label; const stageId = stage.stageId; returnData.push({ name: stageName, value: stageId, }); } return returnData; }, // Get all the companies to display them to user so that he can // select them easily async getCompanies(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/companies/v2/companies/paged'; const companies = await hubspotApiRequestAllItems.call(this, 'results', 'GET', endpoint); for (const company of companies) { const companyName = company.properties.name.value; const companyId = company.companyId; returnData.push({ name: companyName, value: companyId, }); } return returnData; }, // Get all the companies to display them to user so that he can // select them easily async getContacts(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/contacts/v1/lists/all/contacts/all'; const contacts = await hubspotApiRequestAllItems.call(this, 'contacts', 'GET', endpoint); for (const contact of contacts) { const contactName = `${contact.properties.firstname.value} ${contact.properties.lastname.value}` ; const contactId = contact.vid; returnData.push({ name: contactName, value: contactId, }); } return returnData; }, // Get all the deal types to display them to user so that he can // select them easily async getDealTypes(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/properties/v1/deals/properties/named/dealtype'; const dealTypes = await hubspotApiRequest.call(this, 'GET', endpoint); for (const dealType of dealTypes.options) { const dealTypeName = dealType.label ; const dealTypeId = dealType.value; returnData.push({ name: dealTypeName, value: dealTypeId, }); } return returnData; }, // Get all the forms to display them to user so that he can // select them easily async getForms(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/forms/v2/forms'; const forms = await hubspotApiRequest.call(this, 'GET', endpoint, {}, { formTypes: 'ALL' }); for (const form of forms) { const formName = form.name; const formId = form.guid; returnData.push({ name: formName, value: formId, }); } return returnData; }, // Get all the subscription types to display them to user so that he can // select them easily async getSubscriptionTypes(this: ILoadOptionsFunctions): Promise { const returnData: INodePropertyOptions[] = []; const endpoint = '/email/public/v1/subscriptions'; const subscriptions = await hubspotApiRequestAllItems.call(this, 'subscriptionDefinitions', 'GET', endpoint, {}); for (const subscription of subscriptions) { const subscriptionName = subscription.name; const subscriptionId = subscription.id; returnData.push({ name: subscriptionName, value: subscriptionId, }); } return returnData; }, } }; async execute(this: IExecuteFunctions): Promise { const items = this.getInputData(); const returnData: IDataObject[] = []; const length = items.length as unknown as number; let responseData; const qs: IDataObject = {}; const resource = this.getNodeParameter('resource', 0) as string; const operation = this.getNodeParameter('operation', 0) as string; for (let i = 0; i < length; i++) { //https://developers.hubspot.com/docs/methods/deals/deals_overview if (resource === 'deal') { if (operation === 'create') { const body: IDeal = {}; body.properties = []; const association: IAssociation = {}; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const stage = this.getNodeParameter('stage', i) as string; if (stage) { // @ts-ignore body.properties.push({ name: 'dealstage', value: stage }); } if (additionalFields.associatedCompany) { association.associatedCompanyIds = additionalFields.associatedCompany as number[]; } if (additionalFields.associatedVids) { association.associatedVids = additionalFields.associatedVids as number[]; } if (additionalFields.dealName) { // @ts-ignore body.properties.push({ name: 'dealname', value: additionalFields.dealName as string }); } if (additionalFields.closeDate) { // @ts-ignore body.properties.push({ name: 'closedate', value: new Date(additionalFields.closeDate as string).getTime() }); } if (additionalFields.amount) { // @ts-ignore body.properties.push({ name: 'amount', value: additionalFields.amount as string }); } if (additionalFields.dealType) { // @ts-ignore body.properties.push({ name: 'dealtype', value: additionalFields.dealType as string }); } if (additionalFields.pipeline) { // @ts-ignore body.properties.push({ name: 'pipeline', value: additionalFields.pipeline as string }); } body.associations = association; try { const endpoint = '/deals/v1/deal'; responseData = await hubspotApiRequest.call(this, 'POST', endpoint, body); } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } if (operation === 'update') { const body: IDeal = {}; body.properties = []; const updateFields = this.getNodeParameter('updateFields', i) as IDataObject; const dealId = this.getNodeParameter('dealId', i) as string; if (updateFields.stage) { body.properties.push({ name: 'dealstage', value: updateFields.stage as string, }); } if (updateFields.dealName) { // @ts-ignore body.properties.push({ name: 'dealname', value: updateFields.dealName as string }); } if (updateFields.closeDate) { // @ts-ignore body.properties.push({ name: 'closedate', value: new Date(updateFields.closeDate as string).getTime() }); } if (updateFields.amount) { // @ts-ignore body.properties.push({ name: 'amount', value: updateFields.amount as string }); } if (updateFields.dealType) { // @ts-ignore body.properties.push({ name: 'dealtype', value: updateFields.dealType as string }); } if (updateFields.pipeline) { // @ts-ignore body.properties.push({ name: 'pipeline', value: updateFields.pipeline as string }); } try { const endpoint = `/deals/v1/deal/${dealId}`; responseData = await hubspotApiRequest.call(this, 'PUT', endpoint, body); } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } if (operation === 'get') { const dealId = this.getNodeParameter('dealId', i) as string; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; if (additionalFields.includePropertyVersions) { qs.includePropertyVersions = additionalFields.includePropertyVersions as boolean; } try { const endpoint = `/deals/v1/deal/${dealId}`; responseData = await hubspotApiRequest.call(this, 'GET', endpoint); } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } if (operation === 'getAll') { const filters = this.getNodeParameter('filters', i) as IDataObject; const returnAll = this.getNodeParameter('returnAll', 0) as boolean; if (filters.includeAssociations) { qs.includeAssociations = filters.includeAssociations as boolean; } if (filters.properties) { // @ts-ignore qs.properties = filters.properties.split(','); } if (filters.propertiesWithHistory) { // @ts-ignore qs.propertiesWithHistory = filters.propertiesWithHistory.split(','); } try { const endpoint = `/deals/v1/deal/paged`; if (returnAll) { responseData = await hubspotApiRequestAllItems.call(this, 'deals', 'GET', endpoint, {}, qs); } else { qs.limit = this.getNodeParameter('limit', 0) as number; responseData = await hubspotApiRequest.call(this, 'GET', endpoint, {}, qs); responseData = responseData.deals; } } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } if (operation === 'getRecentlyCreated' || operation === 'getRecentlyModified') { let endpoint; const filters = this.getNodeParameter('filters', i) as IDataObject; const returnAll = this.getNodeParameter('returnAll', 0) as boolean; if (filters.since) { qs.since = new Date(filters.since as string).getTime(); } if (filters.includePropertyVersions) { qs.includePropertyVersions = filters.includePropertyVersions as boolean; } try { if (operation === 'getRecentlyCreated') { endpoint = `/deals/v1/deal/recent/created`; } else { endpoint = `/deals/v1/deal/recent/modified`; } if (returnAll) { responseData = await hubspotApiRequestAllItems.call(this, 'results', 'GET', endpoint, {}, qs); } else { qs.count = this.getNodeParameter('limit', 0) as number; responseData = await hubspotApiRequest.call(this, 'GET', endpoint, {}, qs); responseData = responseData.results; } } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } if (operation === 'delete') { const dealId = this.getNodeParameter('dealId', i) as string; try { const endpoint = `/deals/v1/deal/${dealId}`; responseData = await hubspotApiRequest.call(this, 'DELETE', endpoint); } catch (err) { throw new Error(`Hubspot Error: ${JSON.stringify(err)}`); } } } //https://developers.hubspot.com/docs/methods/forms/forms_overview if (resource === 'form') { //https://developers.hubspot.com/docs/methods/forms/v2/get_fields if (operation === 'getFields') { const formId = this.getNodeParameter('formId', i) as string; responseData = await hubspotApiRequest.call(this, 'GET', `/forms/v2/fields/${formId}`); } //https://developers.hubspot.com/docs/methods/forms/submit_form_v3 if (operation === 'submit') { const formId = this.getNodeParameter('formId', i) as string; const additionalFields = this.getNodeParameter('additionalFields', i) as IDataObject; const context = (this.getNodeParameter('contextUi', i) as IDataObject).contextValue as IDataObject; const legalConsent = (this.getNodeParameter('lengalConsentUi', i) as IDataObject).lengalConsentValues as IDataObject; const legitimateInteres = (this.getNodeParameter('lengalConsentUi', i) as IDataObject).legitimateInterestValues as IDataObject; const { portalId } = await hubspotApiRequest.call(this, 'GET', `/forms/v2/forms/${formId}`); const body: IForm = { formId, portalId, legalConsentOptions: {}, fields: [], }; if (additionalFields.submittedAt) { body.submittedAt = new Date(additionalFields.submittedAt as string).getTime(); } if (additionalFields.skipValidation) { body.skipValidation = additionalFields.skipValidation as boolean; } const consent: IDataObject = {}; if (legalConsent) { if (legalConsent.consentToProcess) { consent!.consentToProcess = legalConsent.consentToProcess as boolean; } if (legalConsent.text) { consent!.text = legalConsent.text as string; } if (legalConsent.communicationsUi) { consent.communications = (legalConsent.communicationsUi as IDataObject).communicationValues as IDataObject; } } body.legalConsentOptions!.consent = consent; const fields: IDataObject = items[i].json; for (const key of Object.keys(fields)) { body.fields?.push({ name: key, value: fields[key] }); } if (body.legalConsentOptions!.legitimateInterest) { Object.assign(body, { legalConsentOptions: { legitimateInterest: legitimateInteres } }); } if (context) { Object.assign(body, { context }); } const uri = `https://api.hsforms.com/submissions/v3/integration/submit/${portalId}/${formId}`; responseData = await hubspotApiRequest.call(this, 'POST', '', body, {}, uri); } } if (Array.isArray(responseData)) { returnData.push.apply(returnData, responseData as IDataObject[]); } else { returnData.push(responseData as IDataObject); } } return [this.helpers.returnJsonArray(returnData)]; } }