HubSpot

Create and manage contacts, deals, and companies in HubSpot CRM.

CRM and salesOAuth45 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (45)
create-contact
create-deal
update-contact
add_contact_to_list
add-contact-to-workflow
create-associations
create-blog-post
create-company
create-custome-object
create-line-item
create-or-update-contact
create-page
create-product
create-ticket
custom_api_call
delete-page
find-associations
find-company
find-contact
find-custom-object
find-deal
find-line-item
find-product
find-ticket
get-company
get-contact
get-custom-object
get-deal
get-line-item
get-owner-by-email
get-owner-by-id
get-page
get-pipeline-stage-details
get-product
get-ticket
remove-associations
remove-contact-from-list
remove-email-subscription
update-company
update-custome-object
update-deal
update-line-item
update-product
update-ticket
upload-file
Details

Connect

Auth type: OAuth (oauth2). Click Connect and approve access on the provider's page. Appbricx runs the OAuth flow (signed single-use state, PKCE where the provider supports it), stores the tokens encrypted and refreshes them before they expire.

Scopes requested: crm.objects.contacts.readcrm.objects.contacts.writecrm.objects.deals.read

OAuth needs an OAuth app: the platform's when the operator configured one, or your own (admin panel, Integrations, Configure). You can also bring your own credentials.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("hubspot", "create-contact", {});
  if (!res.success) throw new Error(res.error);
  ctx.log.info("HubSpot answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "hubspot-create-contact",
  name: "HubSpot: Create Contact",
  description: "Calls HubSpot when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("hubspot", {
      "action": "create-contact"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/hubspot/create-contact" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{}}'

Actions

create-contactin catalog

Create Contact. Creates a contact in Hubspot.

Also accepted as create_contact.

Input	Type	Description
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

create-dealin catalog

Create Deal. Creates a new deal in Hubspot.

Input	Type	Description
`dealname`required	text	Deal Name
`pipelineId`required	id (picked from your account)	Deal Pipeline
`pipelineStageId`required	id (picked from your account)	Deal Stage
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

update-contactin catalog

Update Contact. Updates a contact in Hubspot.

Also accepted as update_contact.

Input	Type	Description
`contactId`required	text	The ID of the contact to update.
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

add_contact_to_list

Add contact To List. Add contact to list

Input	Type	Description
`listId`required	id (picked from your account)	List ID
`email`required	text	Contact Email

add-contact-to-workflow

Add Contact to Workflow. Adds a contact to a specified workflow in your HubSpot account.

Input	Type	Description
`workflowId`required	id (picked from your account)	Workflow
`email`required	text	The email of the contact to add to the workflow.

create-associations

Create Associations. Creates associations between objects

Input	Type	Description
`fromObjectId`required	text	The ID of the object being associated.
`fromObjectType`required	id (picked from your account)	The type of the object being associated.
`toObjectType`required	id (picked from your account)	Type of the objects the from object is being associated with.
`associationType`required	id (picked from your account)	Type of the association
`toObjectIds`required	ids (picked from your account)	The ID'sof the objects the from object is being associated with

create-blog-post

Create COS Blog Post. Creates a blog post in you Hubspot COS blog.

Input	Type	Description
`contentGroupId`required	id (picked from your account)	Blog URL
`authorId`required	id (picked from your account)	Blog Author
`status`required	one of "DRAFT" \| "PUBLISHED"	Publish This Post?
`slug`required	text	The slug of the blog post. This is the URL of the post on your COS blog.
`title`required	text	Blog Post Title
`body`required	long text	Blog Post Content
`meta`required	long text	Meta Description
`imageUrl`required	text	Featured Image URL

create-company

Create Company. Creates a company in Hubspot.

Input	Type	Description
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

create-custome-object

Create Custom Object. Creates a custom object in Hubspot.

Input	Type	Description
`customObjectType`required	id (picked from your account)	Type of Custom Object
`objectProperties`optional	object (depends on other props)	Custom Object Properties
`additionalPropertiesToRetrieve`optional	object (depends on other props)	Additional Properties to Retrieve

create-line-item

Create Line Item. Creates a line item in Hubspot.

Input	Type	Description
`productId`required	id (picked from your account)	Line Item Information: Product ID
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

create-or-update-contact

Create or Update Contact. Creates a new contact or updates an existing contact based on email address.

Input	Type	Description
`email`required	text	Contact Email
`objectProperties`optional	object (depends on other props)	Object Properties

create-page

Create Page. Creates a new landing/site page.

Input	Type	Description
`pageType`required	one of "landing_page" \| "site_page"	Page Type
`pageTitle`required	text	Page Title
`internalPageName`required	text	Internal Page Name
`templatePath`required	text	The path should not include a slash (/) at the start.For example,"@hubspot/elevate/templates/blank.hubl.html".
`slug`required	text	Slug
`language`optional	text	Language
`metaDescription`optional	long text	Meta Description
`state`optional	one of "DRAFT" \| "PUBLISHED_OR_SCHEDULED"	State
`headHtml`optional	long text	Additional Head HTML
`footerHtml`optional	long text	Additional Footer HTML

create-product

Create Product. Creates a product in Hubspot.

Input	Type	Description
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

create-ticket

Create Ticket. Creates a ticket in HubSpot.

Input	Type	Description
`ticketName`required	text	The name of the ticket to create.
`pipelineId`required	id (picked from your account)	Ticket Pipeline
`pipelineStageId`required	id (picked from your account)	Ticket Pipeline Stage
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

delete-page

Delete Page. Deletes an existing landing/site page.

Input	Type	Description
`pageType`required	one of "landing_page" \| "site_page"	Page Type
`pageId`required	text	The ID of the page to delete.

find-associations

Find Associations. Finds associations between objects

Input	Type	Description
`fromObjectId`required	text	The ID of the object you want to search the association.
`fromObjectType`required	id (picked from your account)	The type of the object you want to search the association.
`toObjectType`required	id (picked from your account)	Type of the object the from object is being associated with.

find-company

Find Company. Finds a company by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

find-contact

Find Contact. Finds a contact by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

find-custom-object

Find Custom Object. Finds a custom object by searching.

Input	Type	Description
`customObjectType`required	id (picked from your account)	Type of Custom Object
`firstSearchPropertyName`required	object (depends on other props)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	object (depends on other props)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	object (depends on other props)	Additional Properties to Retrieve

find-deal

Find Deal. Finds a deal by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

find-line-item

Find Line Item. Finds a line item by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

find-product

Find Product. Finds a product by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

find-ticket

Find Ticket. Finds a ticket by searching.

Input	Type	Description
`firstSearchPropertyName`required	id (picked from your account)	First search property name
`firstSearchPropertyValue`required	text	First search property value
`secondSearchPropertyName`optional	id (picked from your account)	Second search property name
`secondSearchPropertyValue`optional	text	Second search property value
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-company

Get Company. Gets a company.

Input	Type	Description
`companyId`required	text	The ID of the company to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-contact

Get Contact. Gets a contact.

Input	Type	Description
`contactId`required	text	The ID of the contact to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-custom-object

Get Custom Object. Gets a custom object.

Input	Type	Description
`customObjectType`required	id (picked from your account)	Type of Custom Object
`customObjectId`required	text	The ID of the custom object to get.
`additionalPropertiesToRetrieve`optional	object (depends on other props)	Additional Properties to Retrieve

get-deal

Get Deal. Gets a deal.

Input	Type	Description
`dealId`required	text	The ID of the deal to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-line-item

Get Line Item. Gets a line item.

Input	Type	Description
`lineItemId`required	text	The ID of the line item to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-owner-by-email

Get Owner by Email. Gets an existing owner by email.

Input	Type	Description
`email`required	text	Owner Email

get-owner-by-id

Get Owner by ID. Gets an existing owner by ID.

Input	Type	Description
`ownerId`required	text	Owner ID

get-page

Get Page. Gets landing/site page Details.

Input	Type	Description
`pageType`required	one of "landing_page" \| "site_page"	Page Type
`pageId`required	text	The ID of the page to get.

get-pipeline-stage-details

Get Pipeline Stage Details. Finds and retrieves CRM object pipeline stage details.

Input	Type	Description
`objectType`required	one of "ticket" \| "deal"	Object Type
`pipelineId`required	text	Pipeline ID
`stageId`required	text	Stage ID

get-product

Get Product. Gets a product.

Input	Type	Description
`productId`required	text	The ID of the product to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

get-ticket

Get Ticket. Gets a ticket.

Input	Type	Description
`ticketId`required	text	The ID of the ticket to get.
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

remove-associations

Remove Associations. Removes associations between objects

Input	Type	Description
`fromObjectId`required	text	The ID of the object you want to remove the association from.
`fromObjectType`required	id (picked from your account)	The type of the object you want to remove the association from.
`toObjectType`required	id (picked from your account)	Type of the currently associated objects that you're removing the association from.
`associationType`required	id (picked from your account)	Type of the association
`toObjectIds`required	ids (picked from your account)	The IDs of the currently associated objects that you're removing the association from.

remove-contact-from-list

Remove Contact from List. Remove a contact from a specific list.

Input	Type	Description
`listId`required	id (picked from your account)	List ID
`email`required	text	Contact Email

remove-email-subscription

Remove Email Subscription. Removes email subscription.

Input	Type	Description
`email`required	text	Email

update-company

Update Company. Updates a company in Hubspot.

Input	Type	Description
`companyId`required	text	The ID of the company to update.
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

update-custome-object

Update Custom Object. Updates a custom object in Hubspot.

Input	Type	Description
`customObjectType`required	id (picked from your account)	Type of Custom Object
`customObjectId`required	text	The ID of the custom object to update.
`objectProperties`optional	object (depends on other props)	Custom Object Properties
`additionalPropertiesToRetrieve`optional	object (depends on other props)	Additional Properties to Retrieve

update-deal

Update Deal. Updates a deal in HubSpot.

Input	Type	Description
`dealId`required	text	The ID of the deal to update.
`dealname`optional	text	Deal Name
`pipelineId`optional	id (picked from your account)	Deal Pipeline
`pipelineStageId`optional	id (picked from your account)	Deal Stage
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

update-line-item

Update Line Item. Updates a line item in Hubspot.

Input	Type	Description
`lineItemId`required	text	The ID of the line item to update.
`productId`optional	id (picked from your account)	Line Item Information: Product ID
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

update-product

Update Product. Updates a product in Hubspot.

Input	Type	Description
`productId`required	text	The ID of the product to update.
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

update-ticket

Update Ticket. Updates a ticket in HubSpot.

Input	Type	Description
`ticketId`required	text	The ID of the ticket to update.
`ticketName`optional	text	Ticket Name
`pipelineId`optional	id (picked from your account)	Ticket Pipeline
`pipelineStageId`optional	id (picked from your account)	Ticket Pipeline Stage
`objectProperties`optional	object (depends on other props)	Object Properties
`additionalPropertiesToRetrieve`optional	ids (picked from your account)	Additional properties to retrieve

upload-file

Upload File. Uploads a file to HubSpot File Manager.

Input	Type	Description
`folderId`required	id (picked from your account)	Folder
`fileName`required	text	File Name
`accessLevel`required	one of "PUBLIC_INDEXABLE" \| "PUBLIC_NOT_INDEXABLE" \| "PRIVATE"	Access Level
`file`required	file	File

Details

Id: hubspot
Category: CRM and sales
Tags: crm, sales, contacts, deals, marketing
Package: @activepieces/piece-hubspot@0.8.4
Tier: Built in