• Using GoInsight.AI
  • Tools
Tools
  • Using GoInsight.AI
  • Tools
loading...
No Results
  • ActiveCampaign
  • Asana
  • AWS-S3
  • Coda
  • DingTalk
  • Dropbox
  • FeiShu
  • Github
  • Gitlab
  • Google Calendar
  • Google Developer
  • Google Drive
  • Google Gmail
  • Google Sheets
  • Hubspot
  • Intercom
  • Jenkins
  • MailChimp
  • Microsoft Excel
  • Monday
  • Notion
  • Odoo
  • PayPal
  • Pipedrive
  • Qdrant
  • QuickBooks
  • Redis
  • Search&Crawl
  • ServiceNow
  • Shopify
  • Stripe
  • Trello
  • Twilio
  • WooCommerce
  • WordPress
  • Zendesk
  • Zoom
Home > Tools

Hubspot

1. Overview

Hubspot is a comprehensive CRM platform that provides software and support to help businesses grow better. It includes tools for marketing, sales, customer service, and content management, all powered by a single, connected database.

With the GoInsight Hubspot node, you can seamlessly integrate your CRM data and operations into your automated workflows. This allows you to manage the entire lifecycle of your marketing, sales, and service objects without leaving the GoInsight platform. Key capabilities include:

  • Contact and Company Management: Create, update, retrieve, and delete contact and company records.
  • Deal and Pipeline Tracking: Manage sales opportunities by creating, updating, searching, and deleting deals.
  • Customer Support: Handle customer issues by creating, updating, and retrieving support tickets.
  • Activity Logging: Record customer interactions by creating and managing engagements like notes, calls, and meetings.
  • List Segmentation: Add or remove contacts from specific marketing lists.

2. Prerequisites

Before using this node, you need to have a valid Hubspot account. Depending on the operations you wish to perform, you may need specific permissions (e.g., administrator rights) to create and manage API credentials.

3. Credentials

For a detailed guide on how to obtain and configure your credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

This node allows you to interact with various Hubspot resources, including Companies, Contacts, Deals, Tickets, and more.

Summary

Resource Operation Description
Company Create a Company Creates a new company record in HubSpot CRM.
Company Delete Company Deletes one or more HubSpot companies specified by their company IDs.
Company Find Company Searches for HubSpot companies by domain.
Company Get a Company Retrieves detailed information for a HubSpot company using its ID.
Company Get Many Companies Retrieves multiple HubSpot companies by their IDs.
Company Get Recent Companies Retrieves recently created or updated HubSpot companies with pagination.
Company Update a Company Updates a HubSpot company record by its ID with specified properties.
Contact Create or Update Contact Creates or updates a HubSpot contact record using email as the primary identifier.
Contact Delete Contact Deletes one or more HubSpot contacts specified by their contact IDs.
Contact Get a Contact Retrieves a HubSpot contact identified by either its contact ID or email address.
Contact Get Many Contacts Retrieves multiple HubSpot contacts with pagination support.
Contact Get Recent Contacts Retrieves recently created or updated HubSpot contacts with precise date filtering.
Contact Search Contacts Searches HubSpot contacts by email address or a general query.
Contact List Add Contacts to List Adds multiple contacts to a HubSpot list with batch processing.
Contact List Delete Contacts from List Deletes multiple contacts from a HubSpot list with batch processing.
Deal Create a Deal Creates a new HubSpot deal with specified properties.
Deal Delete Deal Deletes one or more HubSpot deals specified by their deal IDs.
Deal Get Deals Retrieves multiple HubSpot deals by their IDs.
Deal Get Recent Deals Retrieves HubSpot deals created or updated after a specified timestamp.
Deal Search Deals Searches HubSpot deals using text queries with customizable properties and sorting.
Deal Update a Deal Updates a HubSpot deal by its ID with specified properties.
Engagement Create an Engagement Creates HubSpot engagement records (notes, calls, emails, meetings).
Engagement Delete Engagements Deletes one or multiple HubSpot engagements by their IDs.
Engagement Get an Engagement Retrieves a specific HubSpot engagement by its ID.
Engagement Get Many Engagements Retrieves HubSpot engagements with configurable pagination.
Pipeline List Pipelines Retrieves HubSpot CRM pipelines for deals or tickets.
Ticket Create a Ticket Creates a HubSpot support ticket with specified properties.
Ticket Delete Tickets Deletes or archives HubSpot tickets by their IDs with batch support.
Ticket Get Tickets Retrieves HubSpot tickets by their IDs with batch support.
Ticket Update a Ticket Updates a HubSpot ticket by its ID with specified properties.

Operation Details

Create a Company

This workflow creates a new company record in HubSpot CRM using the v3 Companies API.

Input Parameters:

  • CompanyName: Name of the company to be created.

Optional Parameters:

  • CompanyDomain: Company domain name (e.g., example.com).
  • Website: Company website URL (optional).
  • Industry: Industry type of the company. Must use HubSpot industry values (e.g., ACCOUNTING, COMPUTER_SOFTWARE, MARKETING_AND_ADVERTISING). Optional.
  • City: City where the company is located (optional).
  • State: State/province where the company is located (optional).
  • Country: Country where the company is located (optional).
  • Phone: Company phone number (optional).
  • Description: A short statement about the company's mission and goals (optional).

Output:

  • CompanyId (string): HubSpot company ID of the created company.
  • PortalId (string): HubSpot portal ID.
  • CompanyProperties (string): JSON string of the created company's properties.
  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if creation failed, otherwise empty string.

Delete Company

Deletes one or more HubSpot companies specified by their company IDs. This operation cannot be undone.

Input Parameters:

  • CompanyId: A single HubSpot company ID or a comma-separated list of company IDs to be deleted.

Output:

  • AllDeleted (bool): Indicates whether all specified companies were successfully deleted.
  • FailedItems (object-array): A JSON list of failed deletion items with fields: companyId, statusCode, errorMessage.
  • StatusCode (number): Overall operation status code: 200 (all succeeded), 207 (partial success), 500 (all failed), -1 (parameter error).
  • ErrorMessage (string): Overall error message if parameter validation fails, empty otherwise.

Find Company

Search HubSpot companies by domain and return results as a JSON string.

Input Parameters:

  • Domain: The exact company domain to filter by (e.g. example.com).

Optional Parameters:

  • Limit: The maximum number of companies to return, must be between 1 and 100 (default 10).
  • ExactMatch: Whether to use exact match for domain comparison. True for exact match (operator 'EQ'), False for partial match (operator 'CONTAINS_TOKEN').

Output:

  • Results (object-array): A JSON list of company objects. Each object includes fields: id, name, domain, industry, createdate, lastmodifieddate.
  • StatusCode (number): Operation status code: 200 (success), other codes for errors, -1 for parameter validation error.
  • ErrorMessage (string): Overall error message if parameter validation fails, empty otherwise.

Get a Company

Retrieves detailed information for a HubSpot company using its company ID.

Input Parameters:

  • CompanyId: Unique ID of the HubSpot company to retrieve.

Optional Parameters:

  • IncludeMergeAudits: Whether to return any merge history if the company has been previously merged with another company record.

Output:

  • PortalId (string): HubSpot portal ID.
  • CompanyId (string): HubSpot company ID.
  • CompanyName (string): Name of the company.
  • CompanyDomain (string): Company's domain name.
  • IsDeleted (bool): Indicates if the company is marked as deleted.
  • Properties (object): JSON object of company property values.
  • AdditionalDomains (object-array): JSON list of additional domains.
  • StateChanges (object-array): JSON list of state change records.
  • MergeAudits (object-array): JSON list of merge audit records.
  • StatusCode (number): The HTTP status code returned. 204 indicates success, -1 indicates parameter error, 500 indicates an exception.
  • ErrorMessage (string): A string detailing any error encountered during the request or exception thrown.

Get Many Companies

Retrieve multiple HubSpot companies by company IDs and return results as a JSON string.

Input Parameters:

  • CompanyIds: A comma-separated string of company IDs to retrieve.

Optional Parameters:

  • Properties: A comma-separated list of company properties to retrieve.

Output:

  • Companies (string-array): Array of JSON strings, each containing individual company data.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get Recent Companies

Retrieve recently created or updated HubSpot companies with pagination support and return results as a JSON string.

Optional Parameters:

  • UpdatedAfterTimestamp: UNIX timestamp (seconds since epoch) to filter companies updated after this time. If empty, retrieves companies from the last 24 hours.
  • Limit: Maximum number of companies to retrieve (1-100). Default is 50.
  • Properties: Comma-separated list of company properties to retrieve (e.g., name,domain,industry,city). If empty, returns default properties.
  • SortDirection: Sort direction for results by last modified date. Options: ASCENDING or DESCENDING. Default is DESCENDING (newest first).
  • UseSearchEndpoint: Whether to use the search endpoint (more flexible) or the basic objects endpoint. Default is true.

Output:

  • Companies (string-array): Array of JSON strings, each containing individual company data with their properties.
  • TotalCount (number): Total number of companies returned in this request.
  • HasMore (bool): Indicates if there are more companies available beyond this page.
  • PagingAfter (string): Paging cursor for retrieving the next set of results.
  • StatusCode (number): HTTP status code. 200 indicates success, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if retrieval failed, otherwise empty string.

Update a Company

Update a HubSpot company record by company ID with specified properties and return updated company data as a JSON string.

Input Parameters:

  • CompanyId: The unique ID of the company to update.
  • Properties: A JSON object string containing the properties to update.

Output:

  • UpdatedCompany (string): JSON string of the updated company data.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Create or Update Contact

Creates or updates a HubSpot contact record using email as the primary identifier with comprehensive field validation.

Input Parameters:

  • Email: Contact email address - serves as primary identifier.

Optional Parameters:

  • FirstName: Contact first name.
  • LastName: Contact last name.
  • Company: Company name associated with the contact.
  • Phone: Contact phone number.
  • Website: Contact website URL.
  • LifecycleStage: Contact lifecycle stage (e.g., lead, customer, opportunity).

Output:

  • ContactId (string): The unique ID of the contact that was created or updated.
  • IsNewContact (bool): Boolean indicating whether a new contact was created (true) or existing contact was updated (false).
  • StatusCode (number): HTTP response code (-1 for parameter validation errors, 200 for update, 201 for create, 500 for exceptions).
  • ErrorMessage (string): Error message in case of failure; empty if successful.

Delete Contact

Deletes one or more HubSpot contacts specified by their contact IDs. This action cannot be undone.

Input Parameters:

  • ContactId: A single HubSpot contact ID or a comma-separated list of contact IDs to be deleted.

Output:

  • AllDeleted (bool): Indicates whether all specified contacts were successfully deleted.
  • FailedItems (object-array): A JSON list of failed deletion items with fields: contactId, statusCode, errorMessage.
  • StatusCode (number): Overall operation status code: 200 (all succeeded), 207 (partial success), 500 (all failed), -1 (parameter error).
  • ErrorMessage (string): Overall error message if parameter validation fails, empty otherwise.

Get a Contact

Retrieves a HubSpot contact identified by either its contact ID or email address, specifying which properties to return via a comma-separated string, and return the contact as a JSON string.

Input Parameters:

  • ContactIdentifier: A HubSpot contact ID (numeric string) or an email address to identify the contact.

Optional Parameters:

  • Properties: A comma-separated string of Hubspot contact property names to return. Defaults to 'firstname', 'lastname', 'email', 'phone', 'company', 'createdate', 'lastmodifieddate', 'hs_object_id'.

Output:

  • Contact (object): A JSON object containing the contact information retrieved from HubSpot.
  • StatusCode (number): HTTP response code (-1 for parameter validation errors, 500 for exceptions).
  • ErrorMessage (string): Error message in case of failure; empty if successful.

Get Many Contacts

Retrieve multiple HubSpot contacts with pagination support, flexible property selection, and comprehensive error handling for batch processing workflows.

Optional Parameters:

  • Limit: Maximum number of contacts to return per page (default 10, max 100).
  • After: Pagination cursor for retrieving next page of results.
  • Properties: Comma-separated list of contact properties to return.
  • Archived: Whether to return only archived contacts (true/false).
  • PropertiesWithHistory: Comma-separated list of properties to include historical values.

Output:

  • Contacts (string-array): Array of JSON strings, each containing individual contact data.
  • Total (number): Total number of contacts returned in the current response.
  • HasMore (bool): Boolean indicating whether there are more results available.
  • NextCursor (string): Cursor for retrieving the next page of results.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get Recent Contacts

Retrieve recently created or updated HubSpot contacts with precise date filtering, timezone support, and comprehensive

synchronization capabilities for incremental data processing workflows.

Optional Parameters:

  • ModificationType: Type of modification to filter (created, updated, both).
  • StartDate: Start date for filtering (ISO 8601 format: 2024-01-01T00:00:00Z).
  • EndDate: End date for filtering (ISO 8601 format, optional).
  • Limit: Maximum number of contacts to return per page (default 100, max 100).
  • After: Pagination cursor from previous response for retrieving next page of results.
  • Properties: Comma-separated list of contact properties to return.
  • SortDirection: Sort direction for results (ASCENDING or DESCENDING).

Output:

  • Contacts (string-array): Array of JSON strings, each containing individual contact data.
  • Total (number): Total number of contacts returned in the current response.
  • HasMore (bool): Boolean indicating whether there are more results available.
  • NextCursor (string): Cursor for retrieving the next page of results.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Search Contacts

Search HubSpot contacts by email address or general query with flexible matching and comprehensive error handling.

Input Parameters:

  • Query: Search query - if email format detected will do exact email match, otherwise general search.

Optional Parameters:

  • Limit: Maximum number of results to return (default 100, max 100).
  • Properties: Comma-separated list of contact properties to return.

Output:

  • Contacts (string-array): Array of JSON strings, each containing individual contact data.
  • StatusCode (number): HTTP response code (-1 for parameter validation errors, 200 for success, 500 for exceptions).
  • ErrorMessage (string): Error message in case of failure; empty if successful.

Add Contacts to List

Add multiple contacts to a HubSpot list with batch processing and detailed error handling for failed additions.

Input Parameters:

  • ListId: The ID of the list to add contacts to.
  • ContactIds: Comma-separated list of contact IDs to add to the list.

Output:

  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.
  • AddedContacts (number): Number of contacts successfully added to the list.
  • FailedContacts (string-array): Array of JSON strings, each containing details of a contact that failed to be added.
  • Success (bool): Boolean indicating whether the operation was successful.
  • ResponseData (string): Raw response data from the HubSpot API.

Delete Contacts from List

Delete multiple contacts from a HubSpot list with batch processing and detailed error handling for failed removals.

Input Parameters:

  • ListId: The ID of the list to remove contacts from.
  • ContactIds: Comma-separated list of contact IDs to remove from the list.

Output:

  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.
  • RemovedContacts (number): Number of contacts successfully removed from the list.
  • FailedContacts (string-array): Array of JSON strings, each containing details of a contact that failed to be removed.
  • Success (bool): Boolean indicating whether the operation was successful.
  • ResponseData (string): Raw response data from the HubSpot API.

Create a Deal

Create a new HubSpot deal with specified properties including deal name, pipeline, stage, amount, close date, and owner, returning the created deal ID and status code.

Input Parameters:

  • DealName: The name of the deal.

Optional Parameters:

  • PipelineId: The ID of the pipeline the deal belongs to (optional).
  • DealStageId: The ID of the stage the deal is in (optional).
  • Amount: The value of the deal (optional).
  • CloseDate: The expected close date of the deal in milliseconds (optional).
  • DealOwner: The ID of the user who owns the deal (optional).

Output:

  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.
  • DealId (string): HubSpot deal ID of the created/updated deal.

Delete Deal

Deletes one or more HubSpot deals specified by their deal IDs, this action cannot be undone.

Input Parameters:

  • DealId: A single HubSpot deal ID or a comma-separated list of deal IDs to be deleted.

Output:

  • AllDeleted (bool): Indicates whether all specified deals were successfully deleted.
  • FailedItems (object-array): A JSON list of failed deletion items with fields: dealId, statusCode, errorMessage.
  • StatusCode (number): Overall operation status code: 200 (all succeeded), 207 (partial success), 500 (all failed), -1 (parameter error).
  • ErrorMessage (string): Overall error message if parameter validation fails, empty otherwise.

Get Deals

Retrieve multiple HubSpot deals by their IDs with specified properties, returning deal data as a JSON array using batch API for efficient processing.

Input Parameters:

  • DealIds: A comma-separated string of deal IDs to retrieve.

Optional Parameters:

  • Properties: A comma-separated list of deal properties to retrieve.

Output:

  • Deals (string-array): Array of JSON strings, each containing individual deal data.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get Recent Deals

Retrieve HubSpot deals created or updated after a specified timestamp with customizable properties.

Optional Parameters:

  • Limit: Maximum number of deals to retrieve (default: 100, max: 100).
  • After: Pagination cursor for retrieving next set of results.
  • Properties: Comma-separated list of properties to retrieve (e.g., dealname,amount,dealstage).
  • Archived: Whether to include archived deals (true/false).

Output:

  • Deals (string-array): Array of JSON strings, each containing individual deal data.
  • Total (number): Total number of records retrieved.
  • HasMore (bool): Boolean indicating if there are more results available.
  • NextCursor (string): Cursor value for retrieving the next page of results.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Search Deals

Search HubSpot deals using text queries with customizable properties, sorting, and pagination support, returning matching deals as JSON data.

Optional Parameters:

  • Query: The search query string.
  • Limit: Maximum number of deals to retrieve (1-100). Default is 50.
  • Properties: Comma-separated list of deal properties to retrieve (e.g., dealname,amount,dealstage,pipeline). If empty, returns default properties.
  • SortDirection: Sort direction for results by last modified date. Options: ASCENDING or DESCENDING. Default is DESCENDING (newest first).

Output:

  • Deals (string-array): Array containing the retrieved deals data.
  • TotalCount (number): Total number of records found.
  • HasMore (bool): Boolean indicating if there are more results available.
  • PagingAfter (string): After cursor for pagination.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Update a Deal

Update a HubSpot deal by ID with specified properties provided as a JSON object, returning the updated deal data and status information.

Input Parameters:

  • DealId: The unique ID of the deal to update.
  • Properties: A JSON object string containing the properties to update.

Output:

  • UpdatedDeal (string): JSON string of the updated deal data.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Create an Engagement

Create HubSpot engagement records (notes, calls, emails, meetings) with customizable properties and CRM object associations.

Optional Parameters:

  • EngagementType: Type of engagement (NOTE, EMAIL, CALL, MEETING, TASK).
  • Timestamp: Unix timestamp in milliseconds when the engagement occurred.
  • OwnerId: HubSpot user ID of the engagement owner.
  • Metadata: JSON string containing engagement-specific metadata (e.g., body, subject, etc.).
  • Associations: JSON string containing associated record IDs (contactIds, companyIds, dealIds).

Output:

  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.
  • EngagementId (string): HubSpot engagement ID of the created engagement.
  • EngagementData (string): Output parameter: EngagementData.
  • Success (bool): Boolean indicating whether the operation was successful.

Delete Engagements

Delete one or multiple HubSpot engagements. Supports both English comma (,) and Chinese comma (,) as separators. Simple and efficient without unnecessary batch parameters.

Input Parameters:

  • EngagementIds: A single engagement ID or a comma-separated list of engagement IDs to delete. Supports both English (,) and Chinese (,) commas. Examples: '123' or '123,456,789'.

Output:

  • AllDeleted (bool): Boolean indicating whether all engagements were successfully deleted.
  • FailedItems (string-array): Array of JSON strings, each containing details of an engagement that failed to delete.
  • StatusCode (number): 200: All successful, 207: Partial success, 500: All failed, -1: Parameter error.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get an Engagement

Retrieve a specific HubSpot engagement by ID, returning detailed engagement data including metadata, associations, and activity information as JSON.

Input Parameters:

  • EngagementId: The unique ID of the engagement to retrieve.

Output:

  • Engagement (string): Output parameter: Engagement.
  • Associations (string): JSON string of engagement associations with CRM objects.
  • Metadata (string): Output parameter: Metadata.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get Many Engagements

Retrieve HubSpot engagements with configurable pagination and optional bulk fetching capabilities.

Optional Parameters:

  • Limit: Maximum number of engagements per request (default: 100, max: 100).
  • GetAll: Whether to retrieve all engagements by automatically handling pagination.
  • After: Pagination cursor for retrieving next page of results.

Output:

  • Engagements (string-array): Array of JSON strings, each containing individual engagement data.
  • HasMore (bool): Boolean indicating if there are more results available.
  • NextOffset (number): Offset value for retrieving the next page of results.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

List Pipelines

Retrieve HubSpot CRM pipelines with complete configuration details including stages, metadata, and display properties.

Optional Parameters:

  • ObjectType: Type of pipeline to retrieve (deals, tickets).

Output:

  • Pipelines (string-array): Array of JSON strings, each containing individual pipeline data.
  • StatusCode (number): HTTP status code indicating the result of the operation.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Create a Ticket

Create a HubSpot support ticket with specified subject, content, priority, and pipeline stage, optionally associating it with contacts or companies for customer service management.

Input Parameters:

  • Subject: Ticket subject/title (required).

Optional Parameters:

  • Content: Ticket content/description (optional).
  • Pipeline: Ticket pipeline ID. If empty, will use the default pipeline.
  • PipelineStage: Ticket pipeline stage ID: 1=New, 2=Waiting on Contact, 3=Waiting on Us, 4=Closed. If empty, will use stage 1 (New).
  • Priority: Ticket priority (HIGH, MEDIUM, LOW). If empty, will use default priority.
  • Source: Channel where ticket was originally submitted (EMAIL, PHONE, CHAT, etc.).
  • Category: Ticket category for classification (optional).
  • ContactId: HubSpot contact ID to associate with this ticket (optional).
  • CompanyId: HubSpot company ID to associate with this ticket (optional).

Output:

  • TicketId (string): HubSpot ticket ID of the created ticket.
  • TicketProperties (string): JSON string of the created ticket's properties.
  • Associations (string): JSON string of ticket associations with contacts/companies.
  • StatusCode (number): HTTP status code. 201 indicates successful creation, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if creation failed, otherwise empty string.

Delete Tickets

Delete or archive HubSpot tickets by ID with batch support, providing detailed success/failure reporting and safe archive-by-default behavior.

Input Parameters:

  • TicketId: HubSpot ticket ID to be deleted (required). Can be a single ID or comma-separated list of IDs.

Optional Parameters:

  • UseArchive: Whether to archive (move to recycling bin) instead of permanent delete. Default is true (recommended).
  • IdProperty: Property to use as identifier (default is 'id'). Can use unique property like ticket number.

Output:

  • AllDeleted (bool): Boolean indicating whether all tickets were successfully deleted.
  • FailedItems (string-array): Array of JSON strings, each containing details of a ticket that failed to delete.
  • StatusCode (number): 200: All successful, 207: Partial success, 500: All failed, -1: Parameter error.
  • ErrorMessage (string): Error message if the operation failed, otherwise empty.

Get Tickets

Retrieve HubSpot tickets by ID with batch support, customizable properties, associations, and change history, providing detailed success/failure reporting.

Input Parameters:

  • TicketIds: HubSpot ticket IDs to retrieve. Can be a single ID or comma-separated list of IDs (required).

Optional Parameters:

  • Properties: Comma-separated list of ticket properties to retrieve. If empty, returns default properties.
  • IdProperty: Property to use as identifier (default is 'id'). Can use unique property like ticket number.
  • IncludeAssociations: Whether to include associated objects (contacts, companies, deals). Default is false.
  • PropertiesWithHistory: Comma-separated list of properties to include change history for (optional).

Output:

  • Tickets (string-array): Array of JSON strings, each containing individual ticket data.
  • FailItems (string-array): Array of JSON strings containing failed item information.
  • Associations (string-array): Array of JSON strings, each containing ticket associations data.
  • StatusCode (number): HTTP status code. 200 indicates all succeeded, 207 indicates partial success, 500 indicates all failed, -1 indicates parameter error.
  • ErrorMessage (string): Error message if retrieval failed, otherwise empty string.

Update a Ticket

Update a HubSpot ticket by ID with support for standard and custom properties, providing detailed information about updated fields and current ticket state.

Input Parameters:

  • TicketId: HubSpot ticket ID to be updated (required).

Optional Parameters:

  • Subject: Updated ticket subject/title (optional).
  • Content: Updated ticket content/description (optional).
  • PipelineStage: Updated ticket pipeline stage ID (optional).
  • Priority: Updated ticket priority (HIGH, MEDIUM, LOW) (optional).
  • Source: Updated channel where ticket was originally submitted (EMAIL, PHONE, CHAT, etc.) (optional).
  • Category: Updated ticket category for classification (optional).
  • Resolution: Action taken to resolve the ticket (optional).
  • CustomProperties: JSON string of custom properties to update (e.g., {"property_name": "value"}) (optional).
  • IdProperty: Property to use as identifier (default is 'id'). Can use unique property like ticket number.

Output:

  • TicketId (string): HubSpot ticket ID of the updated ticket.
  • UpdatedProperties (string): JSON array of property names that were updated.
  • TicketProperties (string): JSON string of the ticket's current properties after update.
  • StatusCode (number): HTTP status code. 200 indicates successful update, -1 indicates parameter error, 500 indicates exception.
  • ErrorMessage (string): Error message if update failed, otherwise empty string.

5. Example Usage

This section will guide you through creating a simple workflow to add a new company to your Hubspot CRM.

The workflow will consist of three nodes: Start -> Create a Company -> Answer.

Step-by-Step Guide

  1. Add the Hubspot Node:
    • In the workflow canvas, click the "+" icon to add a new node.
    • Select the "Tools" tab in the pop-up panel.
    • Find and select "Hubspot" from the list of tools.
    • In the list of supported operations for Hubspot, click on "Create a Company" to add the node to your canvas.
  2. Configure the Node:
    • Click on the newly added "Create a Company" node to open its configuration panel on the right.
    • Credentials: Find the "Credentials" field at the top. Click the dropdown menu and select your pre-configured Hubspot credentials.
    • Parameters: Fill in the required input parameters.
    • CompanyName: Enter the name for your new company, for example, Innovate Corp.
    • CompanyDomain (Optional): You can enter the company's domain, such as innovatecorp.com.
    • Website (Optional): You can provide the full website URL, like https://www.innovatecorp.com.
  3. Run and Validate:
    • Once all required parameters are correctly filled, any error indicators on the workflow canvas should disappear.
    • Click the "Test Run" button in the top-right corner of the canvas to execute the workflow.
    • After a successful execution, you can click the logs icon (top right) to view the detailed inputs and outputs of the node. You should see the new CompanyId in the output, confirming that the company was created successfully.

Final Workflow

After completing these steps, your workflow is fully configured. When you run it, a new company record will be created in your Hubspot account.

6. FAQs

Q: Why am I receiving a 401 Unauthorized or 403 Forbidden error?

A: This typically indicates an issue with your credentials or permissions. Please check the following:

  • Ensure your API key or OAuth token is correct and has not expired.
  • Verify that the credentials you are using have the necessary scopes/permissions in Hubspot to perform the desired action (e.g., read/write access to contacts).

Q: How can I find the ID for a specific pipeline or deal stage?

A: You can use the List Pipelines operation within GoInsight to retrieve all available pipelines and their stages along with their corresponding IDs. Alternatively, you can often find these IDs in the URL when viewing a specific pipeline's settings within the Hubspot user interface.

Q: What is the correct format for the Properties JSON object in update actions?

A: The Properties parameter expects a valid JSON string where keys are the Hubspot internal property names and values are the new values you want to set. For example, to update a company's name and website, the JSON string would look like this: {"name": "New Company Name", "website": "https://new.example.com"}.

7. Official Documentation

For more in-depth information about the Hubspot API and its capabilities, please refer to the official documentation:

Hubspot Official API Documentation

Updated on: Sep 26, 2025
Was This Page Helpful?
Prev Google Sheets
Next Intercom
Discussion

Leave a Reply. Cancel reply

Your email address will not be published. Required fields are marked*

Product-related questions?Contact Our Support Team to Get a Quick Solution>
On this page
  • 1. Overview
  • 2. Prerequisites
  • 3. Credentials
  • 4. Supported Operations
    • Summary
    • Operation Details
  • 5. Example Usage
    • Step-by-Step Guide
    • Final Workflow
  • 6. FAQs
  • 7. Official Documentation
loading...
No Results