Skip to main content

Hubspot Component

Hubspot

Manage objects and associations in the Hubspot CRM platform

Component key: hubspot

Description​

Hubspot is a Customer Relationship Management software for inbound marketing, sales, and customer service. This component allows you to interact with the Hubspot REST API.

API Documentation​

This component was built using the Hubpost API Documentation

Documentation for Hubspot's REST API used in this component can be found at https://developers.hubspot.com/docs/api/overview.

tip

If a Hubspot API endpoint doesn't have a corresponding action within this component, you can leverage the Raw Request action to make a request to any Hubspot API endpoint.

Processing Hubspot events in real-time​

Hubspot requires that you provide only one webhook URL for your app, and Hubspot will send all customers' events to that URL. If you would like to detect and process changes to your customers' Hubspot accounts in real-time, see the Single-Endpoint Webhook Integrations guide on handling webhook requests from apps that require you to specify a single webhook endpoint.

Connections​

Hubspot OAuth 2.0​

The Hubspot component authenticates requests through a OAuth 2.0 credential. Information on how to generate an OAuth 2.0 credential with Hubspot can be found here Now, you will have to configure a new OAuth 2.0 Hubspot connection in Prismatic.

  • For Client ID and Client Secret enter the values that you got from the Hubspot auth settings.
  • For Scopes choose from the list found on the Hubspot docs
  • Under the Redirect URLs section add https://oauth2.prismatic.io/callback for US based integrations.
    • For integrations outside the US refer to this guide to find your region’s Callback URL.
InputDefaultNotes
App ID
string
appId
Provide the App ID from the Hubspot Developer Console. Required for Webhooks.
Authorize URL
string
/ Required
Hidden Field
authorizeUrl
https://app.hubspot.com/oauth/authorize
The OAuth 2.0 Authorization URL for Hubspot
Client ID
string
/ Required
clientId
Provide the Client Id you received from the Hubspot Developer Console.
Client Secret
password
/ Required
clientSecret
Provide the Client Secret you received from the Hubspot Developer Console.
Developer API Key
string
developerApiKey
Provide the Developer API Key from the Hubspot Developer Console. Required for Webhooks.
Scopes
string
/ Required
scopes
A space-delimited set of one or more scopes to get the user's permission to access.
Token URL
string
/ Required
Hidden Field
tokenUrl
https://api.hubapi.com/oauth/v1/token
The OAuth 2.0 Token URL for Hubspot

Private App Access Token​

InputNotes
Access Token
string
/ Required
accessToken
An access token generated when you create a private app. For testing purposes only - use OAuth 2.0 for production integrations.

Triggers​

Event Type Subscription​

Get notified when a Hubspot event happens. | key: eventTypeSubscription

InputDefaultNotes
Event Types
string
/ Required
Value List
eventTypes
Events to listen for. Make sure to have the right permissions.
Connection
connection
/ Required
hubspotConnection
 
 
Overwrite Webhook Settings
boolean
overwriteWebhookSettings
false
HubSpot only permits one Target URL per App ID. If there's an existing webhook configuration for the current one, this execution will fail unless this toggle is enabled.

Webhook​

Receive and validate webhook requests from Hubspot for webhooks you configure. | key: webhook

InputNotes
Connection
connection
/ Required
hubspotConnection
 

{
  "payload": {
    "headers": {
      "Accept": "*/*",
      "Content-Type": "application/json",
      "Host": "hooks.ci.prismatic-dev.io",
      "User-Agent": "HubSpot Connect 2.0 (http://dev.hubspot.com/) (namespace: webhooks-nio-http-client) - WebhooksExecutorDaemon-executor",
      "X-Amz-Cf-Id": "ABCDEFGHI",
      "X-Amzn-Trace-Id": "Root=1-65dd10e7-527c83667c3d96380250fd05",
      "X-Forwarded-For": "54.174.62.123, 15.158.50.123",
      "X-HubSpot-Request-Timestamp": "1708986599647",
      "X-HubSpot-Signature": "123456789",
      "X-HubSpot-Signature-v3": "123456789",
      "X-HubSpot-Signature-Version": "v1",
      "X-HubSpot-Timeout-Millis": "10000",
      "X-Trace": ""
    },
    "queryParameters": null,
    "rawBody": {
      "data": ""
    },
    "body": {
      "data": [
        {
          "eventId": 123456,
          "subscriptionId": 123456,
          "portalId": 123456,
          "appId": 123456,
          "occurredAt": 1708986598741,
          "subscriptionType": "contact.creation",
          "attemptNumber": 0,
          "objectId": 2001,
          "changeFlag": "CREATED",
          "changeSource": "CRM_UI",
          "sourceId": "userId:123456"
        }
      ],
      "contentType": "application/json"
    },
    "pathFragment": "",
    "webhookUrls": {
      "Webhook": "https://hooks.ci.prismatic-dev.io/trigger/123456=="
    },
    "webhookApiKeys": {
      "Webhook": [
        "sample-api-key"
      ]
    },
    "invokeUrl": "https://hooks.ci.prismatic-dev.io/trigger/123456==",
    "executionId": "123456",
    "customer": {
      "id": "testCustomerId",
      "name": "Test Customer",
      "externalId": "testCustomerExternalId"
    },
    "instance": {
      "id": "123456",
      "name": "Hubspot - Webhook"
    },
    "user": {
      "id": "testUserId",
      "email": "testUserEmail@example.com",
      "name": "Test User",
      "externalId": "testUserExternalId"
    },
    "integration": {
      "id": "123456",
      "name": "Hubspot - Webhook",
      "versionSequenceId": "testIntegrationVersionSequenceId"
    },
    "flow": {
      "id": "123456==",
      "name": "Webhook"
    }
  }
}

Data Sources​

Object Selection​

A list of Hubspot objects | key: getObjectSelection | type: objectSelection

InputDefaultNotes
Hubspot Connection
connection
/ Required
connection
 
 
Include Custom Objects
boolean
includeCustomObjects
 
Objects to Select
string
Value List
objectsToSelect
The objects to include in the selection list.

Actions​

Archive Association​

Remove the associations between two provided objects | key: ArchiveAssociations

InputDefaultNotesExample
Type Of Association
string
/ Required
associateType
Provide a value for the type of association to perform. You can get the set of available values for this input by making a step using the "List Association Types"
890435
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
From Id
string
/ Required
fromId
Provide a value for the unique identifier of the first object
890435
From Object Type
string
/ Required
fromObjectType
The type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
contact
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000
To Id
string
/ Required
toId
Provide a value for the unique identifier of the second object
890435
To Object Type
string
/ Required
toObjectType
The type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
deal

{
  "data": {}
}

Archive Batch Contacts​

Archive a batch of contacts by ID | key: archiveBatchContacts

InputDefaultNotesExample
Contact Ids
string
/ Required
Value List
contactIds
A list of contact IDs.
 
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Archive Batch Engagement​

Archives a batch of selected engagements by their IDs. | key: archiveBatchEngagement

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Ids
string
/ Required
Value List
engagementIds
A list of engagement IDs.
 
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Cancel Import​

Cancels an active import. | key: cancelImport

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Import Id
string
/ Required
importId
Provide the unique identifier of the import.
43203123
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "completedAt": "2024-02-07T05:02:32.700Z",
    "requestedAt": "2024-02-07T05:02:32.700Z",
    "startedAt": "2024-02-07T05:02:32.700Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "status": "PENDING"
  }
}

Create Association​

Create an association between the objects identified in the step | key: createAssociations

InputDefaultNotesExample
Type Of Association
string
/ Required
associateType
Provide a value for the type of association to perform. You can get the set of available values for this input by making a step using the "List Association Types"
890435
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
From Id
string
/ Required
fromId
Provide a value for the unique identifier of the first object
890435
From Object Type
string
/ Required
fromObjectType
The type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
contact
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000
To Id
string
/ Required
toId
Provide a value for the unique identifier of the second object
890435
To Object Type
string
/ Required
toObjectType
The type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
deal

{
  "data": {
    "completedAt": "2024-02-26T23:59:28.273Z",
    "requestedAt": "2024-02-26T23:59:28.273Z",
    "startedAt": "2024-02-26T23:59:28.273Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "results": [
      {
        "from": {
          "id": "37295"
        },
        "to": {
          "id": "37295"
        },
        "type": "contact_to_company"
      }
    ],
    "status": "PENDING"
  }
}

Create Batch Contacts​

Create a batch of contacts | key: createBatchContacts

InputDefaultNotesExample
Batch Contacts
code
/ Required
batchInputs
An array of contact objects to create. See https://developers.hubspot.com/docs/api/crm/contacts for properties.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "completedAt": "2024-02-21T08:27:09.446Z",
    "requestedAt": "2024-02-21T08:27:09.446Z",
    "startedAt": "2024-02-21T08:27:09.446Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "results": [
      {
        "createdAt": "2024-02-21T08:27:09.446Z",
        "archived": false,
        "archivedAt": "2024-02-21T08:27:09.446Z",
        "propertiesWithHistory": {
          "additionalProp1": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.446Z"
            }
          ],
          "additionalProp2": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.446Z"
            }
          ],
          "additionalProp3": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.446Z"
            }
          ]
        },
        "id": "512",
        "properties": {
          "property_date": "1572480000000",
          "property_radio": "option_1",
          "property_number": "17",
          "property_string": "value",
          "property_checkbox": "false",
          "property_dropdown": "choice_b",
          "property_multiple_checkboxes": "chocolate;strawberry"
        },
        "updatedAt": "2024-02-21T08:27:09.446Z"
      }
    ],
    "status": "PENDING"
  }
}

Create Batch Engagement​

Creates a batch of selected engagements. | key: createBatchEngagement

InputDefaultNotesExample
Batch Engagements
code
/ Required
batchInputs
An array of engagement objects to create. Each engagement object must contain the required properties for the specified engagement type. See https://developers.hubspot.com/docs/api/crm/tasks for more information.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "status": "COMPLETE",
    "results": [
      {
        "id": "654321",
        "properties": {
          "hs_body_preview": "Send Proposal",
          "hs_body_preview_html": "<html>\n <head></head>\n <body>\n Send Proposal\n </body>\n</html>",
          "hs_body_preview_is_truncated": "false",
          "hs_createdate": "2024-02-14T02:09:49.695Z",
          "hs_lastmodifieddate": "2024-02-14T02:09:49.695Z",
          "hs_object_id": "654321",
          "hs_object_source": "INTEGRATION",
          "hs_object_source_id": "123456",
          "hs_object_source_label": "INTEGRATION",
          "hs_pipeline_stage": "dd5826e4-c976-4654-a527-b59ada512345",
          "hs_task_body": "Send Proposal",
          "hs_task_completion_count": "0",
          "hs_task_family": "SALES",
          "hs_task_for_object_type": "OWNER",
          "hs_task_is_all_day": "false",
          "hs_task_is_completed": "0",
          "hs_task_is_completed_call": "0",
          "hs_task_is_completed_email": "0",
          "hs_task_is_completed_linked_in": "0",
          "hs_task_is_completed_sequence": "0",
          "hs_task_is_overdue": "true",
          "hs_task_is_past_due_date": "true",
          "hs_task_missed_due_date": "true",
          "hs_task_missed_due_date_count": "1",
          "hs_task_priority": "HIGH",
          "hs_task_status": "WAITING",
          "hs_task_subject": "Follow-up for Brian Buyer",
          "hs_task_type": "CALL",
          "hs_timestamp": "2019-10-30T03:30:17.883Z"
        },
        "createdAt": "2024-02-14T02:09:49.695Z",
        "updatedAt": "2024-02-14T02:09:49.695Z",
        "archived": false
      }
    ],
    "startedAt": "2024-02-14T02:09:49.666Z",
    "completedAt": "2024-02-14T02:09:49.903Z"
  }
}

Create Company​

Create a new company | key: createCompany

InputDefaultNotesExample
City
string
city
Provide a string value for the city of the company
Atherton
Company Name
string
/ Required
companyName
Provide a string value for the name of the company
Acme Inc.
Phone
string
companyPhone
Provide a value for the phone number of the company.
(800) 555-1515
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Description
string
description
Provide the description of the object.
This is an example description.
Domain
string
domain
Provide a string value for the domain of the company
www.example.com
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Industry
string
industry
Provide a string value for the industry of the company
Software
State
string
state
Provide a string value for the state of the company
California
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "createdAt": "2024-02-27T00:06:42.321Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:06:42.321Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.321Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.321Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.321Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:06:42.321Z"
  }
}

Create Contact​

Create a new contact | key: CreateContact

InputDefaultNotesExample
Company
string
contactCompany
Provide a string value for the company of the contact
Acme Inc.
Email
string
contactEmail
Provide a string value for the email of the contact. Getting contacts by email performs a search function and will return a successful output even when no results are found.
someone@example.com
First Name
string
/ Required
contactFirstName
Provide a string value for the first name of the contact
John
Last Name
string
/ Required
contactlastName
Provide a string value for the last name of the contact
Doe
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Phone
string
phone
Provide a value for the phone number.
(877) 929-0687
Timeout
string
timeout
The maximum time a client will await a request
20000
Website
string
website
Provide a string value for the website.
www.example.com

{
  "data": {
    "createdAt": "2024-02-27T00:20:24.825Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:20:24.825Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.825Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.825Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.825Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:20:24.825Z"
  }
}

Create Custom Object​

Creates new custom object schema | key: createCustomObject

InputDefaultNotesExample
Associated Objects
string
Value List
associatedObjects
000xxx
Associations defined for this object type.
my_object_property
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Name
string
/ Required
name
A unique name for this object. For internal use only.
my_object
Plural Label
string
/ Required
pluralLabel
The word for multiple objects. (There's no way to change this later.)
My object
Properties
code
/ Required
properties
Properties defined for this object type.
Required Properties
string
Value List
requiredProperties
000xxx
The names of properties that should be required when creating an object of this type.
my_object_property
Searchable Properties
string
Value List
searchableProperties
000xxx
Names of properties that will be indexed for this object type in by HubSpot's product search.
my_object_property
Secondary Display Properties
string
Value List
secondaryDisplayProperties
000xxx
The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
my_object_property
Singular Label
string
/ Required
singularLabel
The word for one object. (There's no way to change this later.)
My object
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "123456",
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-20T18:09:07.555Z",
    "properties": [
      {
        "updatedAt": "2020-02-20T18:07:11.802Z",
        "createdAt": "2020-02-20T18:07:11.802Z",
        "name": "my_object_property",
        "label": "My object property",
        "type": "string",
        "fieldType": "text",
        "groupName": "my_object_information",
        "displayOrder": -1,
        "calculated": false,
        "externalOptions": false,
        "archived": false,
        "hasUniqueValue": false
      }
    ],
    "associations": [
      {
        "id": "123",
        "fromObjectTypeId": "2-123456",
        "toObjectTypeId": "0-1",
        "name": "my_object_to_contact"
      }
    ],
    "labels": {
      "singular": "My object",
      "plural": "My objects"
    },
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property",
    "metaType": "PORTAL_SPECIFIC",
    "fullyQualifiedName": "p7878787_my_object\"",
    "name": "my_object"
  }
}

Create Deal​

Create a new deal | key: createDeal

InputDefaultNotesExample
Amount
string
amount
Provide a string value for the amount.
34,000
Close Date
string
closeDate
Provide a date representing when the sale will close.
2019-12-07T16:50:06.678Z
Deal Name
string
/ Required
dealName
Provide a string value for the name of the deal
My Example Deal
Deal Stage
string
/ Required
dealStage
Provide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
presentationscheduled
Deal Type
string
dealType
Provide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through Hubspot
newbusiness
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Owner Id
string
hubspotOwnerId
Provide a string value for the owner of the resource
910901
Pipeline
string
/ Required
pipeline
Provide a string value for which pipeline to interact with.
default
Priority
string
priority
Provide a string value for priority of the deal.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "createdAt": "2024-02-27T00:24:54.526Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:24:54.526Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.526Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.526Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.526Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:24:54.526Z"
  }
}

Create Engagement​

Create a communication, email, call, meeting, note, postal mail or task engagement in HubSpot CRM. | key: createEngagement

InputDefaultNotesExample
Associations
code
/ Required
associationsJson
To create and associate a task with existing records.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Properties
code
/ Required
properties
A properties object, attributes depend on the engagement type. For possible properties for each engagement type go to https://developers.hubspot.com/docs/api/crm/tasks.
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "123456789",
    "properties": {
      "hs_body_preview": "Send Proposal",
      "hs_body_preview_html": "<html>\n <head></head>\n <body>\n Send Proposal\n </body>\n</html>",
      "hs_body_preview_is_truncated": "false",
      "hs_createdate": "2024-02-12T21:27:23.876Z",
      "hs_lastmodifieddate": "2024-02-12T21:27:23.876Z",
      "hs_object_id": "123456789",
      "hs_object_source": "INTEGRATION",
      "hs_object_source_id": "654321",
      "hs_object_source_label": "INTEGRATION",
      "hs_task_body": "Send Proposal",
      "hs_task_completion_count": "0",
      "hs_task_family": "SALES",
      "hs_task_for_object_type": "OWNER",
      "hs_task_is_all_day": "false",
      "hs_task_is_completed": "0",
      "hs_task_is_completed_call": "0",
      "hs_task_is_completed_email": "0",
      "hs_task_is_completed_linked_in": "0",
      "hs_task_is_completed_sequence": "0",
      "hs_task_is_overdue": "true",
      "hs_task_is_past_due_date": "true",
      "hs_task_missed_due_date": "true",
      "hs_task_missed_due_date_count": "1",
      "hs_task_priority": "HIGH",
      "hs_task_status": "WAITING",
      "hs_task_subject": "Follow-up for Brian Buyer",
      "hs_task_type": "CALL",
      "hs_timestamp": "2024-01-30T03:30:17.883Z"
    },
    "createdAt": "2024-02-12T21:27:23.876Z",
    "updatedAt": "2024-02-12T21:27:23.876Z",
    "archived": false
  }
}

Create Line Item​

Create a new line item | key: createLineItem

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Name
string
/ Required
lineItemName
Provide a string value for the name of the line item.
My Line Item
Price
string
/ Required
price
Provide the price of the product.
80400
Product Id
string
/ Required
productId
Provide the unique identifier of the product.
804874
Quantity
string
quantity
Provide a string value for the quantity of product in the line item.
80
Recurring Billing Monthly Rate
string
recurringBillingFrequency
Provide a string value for the quantity of product in the line item.
 
Recurring Billing Frequency
string
recurringBillingPeriod
Provide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
P12M
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "createdAt": "2024-02-27T00:31:42.469Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:31:42.469Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.469Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.469Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.469Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "name": "1 year implementation consultation",
      "price": "6000.00",
      "quantity": "2",
      "hs_product_id": "191902",
      "recurringbillingfrequency": "monthly",
      "hs_recurring_billing_period": "P24M"
    },
    "updatedAt": "2024-02-27T00:31:42.469Z"
  }
}

Create Product​

Create a new product | key: createProduct

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Description
string
description
Provide the description of the object.
This is an example description.
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Price
string
/ Required
price
Provide the price of the product.
80400
Product Name
string
/ Required
productName
Provide the name of the product.
myProduct
Recurring Billing Frequency
string
recurringBillingPeriod
Provide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
P12M
Product SKU
string
/ Required
sku
Provide the SKU of the product.
804874
Timeout
string
timeout
The maximum time a client will await a request
20000
Unit Cost
string
unitCost
Provide the unit cost of the product.
800

{
  "data": {
    "createdAt": "2024-02-27T00:35:05.442Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:35:05.442Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.442Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.442Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.442Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "name": "Implementation Service",
      "price": "6000.00",
      "hs_sku": "191902",
      "description": "Onboarding service for data product",
      "hs_cost_of_goods_sold": "600.00",
      "hs_recurring_billing_period": "P12M"
    },
    "updatedAt": "2024-02-27T00:35:05.442Z"
  }
}

Create Webhook​

Create a webhook in HubSpot | key: createWebhook

InputDefaultNotesExample
Active
boolean
/ Required
active
false
Determines if the subscription is active or paused. Defaults to false.
 
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Event Type
string
/ Required
eventType
Type of event to listen for. Can be one of create, delete, deletedForPrivacy, or propertyChange.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Property Name
string
propertyWebhookName
The internal name of the property to monitor for changes. Only applies when eventType is propertyChange.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "createdAt": "2024-02-16T20:53:52.517Z",
    "propertyName": "string",
    "active": true,
    "eventType": "contact.propertyChange",
    "id": "string",
    "updatedAt": "2024-02-16T20:53:52.517Z"
  }
}

Delete all Instanced Webhooks​

Delete all webhooks created by this instance in HubSpot | key: deleteAllWebhooks

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "message": "All webhooks deleted successfully"
  }
}

Delete Company​

Delete an existing company by Id | key: deleteCompany

InputDefaultNotesExample
Company Id
string
/ Required
companyId
Provide a value for the unique identifier of the company.
097829
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Contact​

Delete a contact by Id | key: deleteContact

InputDefaultNotesExample
Contact Id
string
/ Required
contactId
Provide a string value for the unique identifier of the contact.
9989223
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Custom Object​

Removes custom object schema | key: deleteCustomObject

InputDefaultNotesExample
Return Archived Results
boolean
/ Required
archived
Whether to return only results that have been archived.
 
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Object Type
string
/ Required
objectType
Provide a string value for the type of object
deal
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "123456",
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-20T18:09:07.555Z",
    "properties": [
      {
        "updatedAt": "2020-02-20T18:07:11.802Z",
        "createdAt": "2020-02-20T18:07:11.802Z",
        "name": "my_object_property",
        "label": "My object property",
        "type": "string",
        "fieldType": "text",
        "groupName": "my_object_information",
        "displayOrder": -1,
        "calculated": false,
        "externalOptions": false,
        "archived": false,
        "hasUniqueValue": false
      }
    ],
    "associations": [
      {
        "id": "123",
        "fromObjectTypeId": "2-123456",
        "toObjectTypeId": "0-1",
        "name": "my_object_to_contact"
      }
    ],
    "labels": {
      "singular": "My object",
      "plural": "My objects"
    },
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property",
    "metaType": "PORTAL_SPECIFIC",
    "fullyQualifiedName": "p7878787_my_object\"",
    "name": "my_object"
  }
}

Delete Deal​

Delete a deal by its Id | key: deleteDeal

InputDefaultNotesExample
Deal Id
string
/ Required
dealId
Provide the unique identifier of the deal
804874
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Engagement​

Deletes an engagement by its ID. | key: deleteEngagement

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Id
string
/ Required
engagementId
The unique identifier of the engagement. A taskId, meetingId, etc.
123456
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Line Item​

Delete an existing line item by Id | key: deleteLineItem

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Line Item Id
string
/ Required
lineItemId
Provide the unique identifier of the line item.
78349093
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Product​

Delete a product by Id | key: deleteProduct

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Product Id
string
/ Required
productId
Provide the unique identifier of the product.
804874
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Delete Webhook​

Delete a webhook by ID in HubSpot | key: deleteWebhook

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Subscription ID
string
/ Required
subscriptionId
The ID of the subscription to delete
123456789
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {}
}

Export CRM Data​

Begins exporting CRM data for the portal as specified in the request body. | key: exportCRMData

InputDefaultNotesExample
Associated Object Type
string
associatedObjectType
The name or ID of an associated object to include in the export. If you include an associated object, the export will contain the associated record IDs of that object and the records' primary display property value.
name
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Export Name
string
/ Required
exportName
The name of the export.
My Export
Format
string
/ Required
format
CSV
The format of the export file.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Language
string
/ Required
language
The language of the export file.
 
List Id (Only and required for PublicExportListRequest)
string
listId
The ILS List ID of the list to export.
123456
Object Properties
string
/ Required
Value List
objectProperties
A list of the properties you want included in your export.
email
Object Type
string
/ Required
objectType
The name or ID of the object you're exporting. For standard objects, you can use the object's name (e.g., CONTACT), but for custom objects, you must use the objectTypeId value, you can find this value in the response of the List Custom Objects action.
deal
Public CRM Search Request (Only for PublicExportViewRequest)
code
publicCrmSearchRequest
Indicates which data should be exported based on certain property values and search queries.
Schema Type
string
/ Required
schemaType
VIEW
Schema type for the export.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "id": "string"
  }
}

Get an Import​

Get a complete summary of an import record, including any updates. | key: getAnImport

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Import Id
string
/ Required
importId
Provide the unique identifier of the import.
43203123
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "importTemplate": {
      "templateType": "admin_defined",
      "templateId": 0
    },
    "createdAt": "2024-02-07T05:02:32.691Z",
    "metadata": {
      "counters": {
        "TOTAL_ROWS": 2,
        "CREATED_OBJECTS": 1,
        "UPDATED_OBJECTS": 1,
        "UNIQUE_OBJECTS_WRITTEN": 2,
        "PROPERTY_VALUES_EMITTED": 2
      },
      "fileIds": [
        "3579849"
      ],
      "objectLists": [
        {
          "listId": "3",
          "objectType": "contacts"
        }
      ]
    },
    "importRequestJson": {},
    "importSource": "API",
    "importName": "string",
    "state": "DONE",
    "id": "1471",
    "optOutImport": false,
    "updatedAt": "2024-02-07T05:02:32.692Z"
  }
}

Get Batch Contacts​

Read a batch of contacts by internal ID, or unique property values. | key: getBatchContacts

InputDefaultNotesExample
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Contact Ids
string
Value List
contactIds
A list of contact IDs.
 
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Id Property
string
idProperty
An ID property to search by
 
Property
string
Value List
properties
A list of properties to read by.
 
Properties With History
string
Value List
propertiesWithHistory
A list of properties to read by.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "completedAt": "2024-02-21T08:27:09.454Z",
    "requestedAt": "2024-02-21T08:27:09.454Z",
    "startedAt": "2024-02-21T08:27:09.454Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "results": [
      {
        "createdAt": "2024-02-21T08:27:09.454Z",
        "archived": false,
        "archivedAt": "2024-02-21T08:27:09.454Z",
        "propertiesWithHistory": {
          "additionalProp1": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.454Z"
            }
          ],
          "additionalProp2": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.454Z"
            }
          ],
          "additionalProp3": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.454Z"
            }
          ]
        },
        "id": "512",
        "properties": {
          "property_date": "1572480000000",
          "property_radio": "option_1",
          "property_number": "17",
          "property_string": "value",
          "property_checkbox": "false",
          "property_dropdown": "choice_b",
          "property_multiple_checkboxes": "chocolate;strawberry"
        },
        "updatedAt": "2024-02-21T08:27:09.454Z"
      }
    ],
    "status": "PENDING"
  }
}

Get Company​

Retrieve the information or metadata of a company by Id, domain, or name | key: getCompany

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Company Id
string
companyId
Provide a value for the unique identifier of the company.
097829
Company Name
string
companyName
Provide a string value for the name of the company
Acme Inc.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Domain
string
domain
Provide a string value for the domain of the company
www.example.com
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

Get Contact​

Get the information and metadata of a contact by Id or Email | key: getContact

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Email
string
contactEmail
Provide a string value for the email of the contact. Getting contacts by email performs a search function and will return a successful output even when no results are found.
someone@example.com
Contact Id
string
contactId
Provide a string value for the unique identifier of the contact.
9989223
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

Get Current User​

Return information about the current session's user. | key: getCurrentUser

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": {
      "portalId": 123456,
      "timeZone": "US/Eastern",
      "accountType": "DEVELOPER_TEST",
      "currency": "USD",
      "utcOffset": "-05:00",
      "utcOffsetMilliseconds": -18000000,
      "user_id": 456789,
      "user": "example@mail.com"
    }
  }
}

Get Custom Object​

Retrieves a specific custom object | key: getCustomObject

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Object Type
string
/ Required
objectType
Provide a string value for the type of object
deal
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "123456",
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-20T18:09:07.555Z",
    "properties": [
      {
        "updatedAt": "2020-02-20T18:07:11.802Z",
        "createdAt": "2020-02-20T18:07:11.802Z",
        "name": "my_object_property",
        "label": "My object property",
        "type": "string",
        "fieldType": "text",
        "groupName": "my_object_information",
        "displayOrder": -1,
        "calculated": false,
        "externalOptions": false,
        "archived": false,
        "hasUniqueValue": false
      }
    ],
    "associations": [
      {
        "id": "123",
        "fromObjectTypeId": "2-123456",
        "toObjectTypeId": "0-1",
        "name": "my_object_to_contact"
      }
    ],
    "labels": {
      "singular": "My object",
      "plural": "My objects"
    },
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property",
    "metaType": "PORTAL_SPECIFIC",
    "fullyQualifiedName": "p7878787_my_object\"",
    "name": "my_object"
  }
}

Get Deal​

Retrieve information and metadata about a deal by its Id or name | key: getDealById

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Deal Id
string
dealId
Provide the unique identifier of the deal
804874
Deal Name
string
dealName
Provide a string value for the name of the deal
My Example Deal
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

Get Engagement​

Get a communication, email, call, meeting, note, postal mail or task engagement object from HubSpot CRM. | key: getEngagement

InputDefaultNotesExample
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations
string
Value List
associations
List of object types to retrieve associated IDs for. If the specified association do not exist, it will be ignored.
contact
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Id
string
/ Required
engagementId
The unique identifier of the engagement. A taskId, meetingId, etc.
123456
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Id Property
string
idProperty
The name of a property whose values are unique for this object type.
 
Properties To Return
string
Value List
propertiesToReturn
Properties to be returned in the response. If the specified property is not present on the requested object, it will be ignored.
 
Property With History To Return
string
Value List
propertiesWithHistoryToReturn
A property to be returned along with it's history of previous values. If the specified property is not present on the requested object, it will be ignored.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "12345",
    "properties": {
      "hs_createdate": "2024-02-12T01:42:51.758Z",
      "hs_lastmodifieddate": "2024-02-12T01:42:51.950Z",
      "hs_object_id": "12345",
      "hs_task_body": "<div style=\"\" dir=\"auto\" data-top-level=\"true\"><br></div>",
      "hs_timestamp": "2024-02-14T14:00:00Z"
    },
    "propertiesWithHistory": {
      "hs_task_body": [
        {
          "value": "<div style=\"\" dir=\"auto\" data-top-level=\"true\"><br></div>",
          "timestamp": "2024-02-12T01:42:51.758Z",
          "sourceType": "CRM_UI",
          "sourceId": "userId:12345",
          "updatedByUserId": 12345
        }
      ]
    },
    "createdAt": "2024-02-12T01:42:51.758Z",
    "updatedAt": "2024-02-12T01:42:51.950Z",
    "archived": false
  }
}

Get Line Item​

Retrieve the information and metadata of a line item by Id | key: getLineItem

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Line Item Id
string
lineItemId
Provide the unique identifier of the line item.
78349093
Name
string
lineItemName
Provide a string value for the name of the line item.
My Line Item
Timeout
string
timeout
The maximum time a client will await a request
20000

Get Product​

Retrieve the information and metadata of a product by Id or name | key: getProduct

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Product Id
string
productId
Provide the unique identifier of the product.
804874
Product Name
string
productName
Provide the name of the product.
myProduct
Timeout
string
timeout
The maximum time a client will await a request
20000

Import CRM Data​

Import CRM records and activities into your HubSpot account, such as contacts, companies, and notes. | key: importCRMData

InputDefaultNotesExample
Create Contact List From Import
boolean
createContactListFromImport
false
An optional field to create a static list of the contacts from your import. To create a list from your file, use the value true.
 
Data CSV File
data
/ Required
Key Value List
dataFiles
The CSV file to import, this should be binary data from a previous step. Key name should be the file name and the value should be the binary data.
key: 'contact-import-file.csv', value: 'binary data'
Date Format
string
/ Required
dateFormat
MONTH_DAY_YEAR
The format for dates included in the file. By default, this is set to MONTH_DAY_YEAR, but you can also use DAY_MONTH_YEAR or YEAR_MONTH_DAY.
YEAR_MONTH_DAY
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Files
code
/ Required
files
An array that contains your import file information. For more information, see https://developers.hubspot.com/docs/api/crm/imports.
Connection
connection
/ Required
hubspotConnection
 
 
 
Import Operations
code
importOperations
An optional field used to indicate whether the import should create and update, only create, or only update records for a certain object or activity. Include the objectTypeId for the object/activity and whether you want to UPSERT (create and update), CREATE, or UPDATE records. For objectTypeId's, check https://developers.hubspot.com/docs/api/crm/understanding-the-crm#object-type-id
Marketable Contact Import
boolean
marketableContactImport
true
Whether the contacts being imported are marketable. If not provided, the default value is true.
 
Name
string
/ Required
name
The name of the import.
Contact Company import
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "importTemplate": {
      "templateType": "admin_defined",
      "templateId": 0
    },
    "createdAt": "2024-02-07T05:02:32.679Z",
    "metadata": {
      "counters": {
        "TOTAL_ROWS": 2,
        "CREATED_OBJECTS": 1,
        "UPDATED_OBJECTS": 1,
        "UNIQUE_OBJECTS_WRITTEN": 2,
        "PROPERTY_VALUES_EMITTED": 2
      },
      "fileIds": [
        "3579849"
      ],
      "objectLists": [
        {
          "listId": "3",
          "objectType": "contacts"
        }
      ]
    },
    "importRequestJson": {},
    "importSource": "API",
    "importName": "string",
    "state": "DONE",
    "id": "1471",
    "optOutImport": false,
    "updatedAt": "2024-02-07T05:02:32.679Z"
  }
}

List Active Imports​

Returns a paged list of active imports for this account. | key: listActiveImports

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": [
    {
      "importTemplate": {
        "templateType": "admin_defined",
        "templateId": 0
      },
      "createdAt": "2024-02-07T05:02:32.668Z",
      "metadata": {
        "counters": {
          "TOTAL_ROWS": 2,
          "CREATED_OBJECTS": 1,
          "UPDATED_OBJECTS": 1,
          "UNIQUE_OBJECTS_WRITTEN": 2,
          "PROPERTY_VALUES_EMITTED": 2
        },
        "fileIds": [
          "3579849"
        ],
        "objectLists": [
          {
            "listId": "3",
            "objectType": "contacts"
          }
        ]
      },
      "importRequestJson": {},
      "importSource": "API",
      "importName": "string",
      "state": "DONE",
      "id": "1471",
      "optOutImport": false,
      "updatedAt": "2024-02-07T05:02:32.668Z"
    }
  ]
}

List Association Types​

Retrieve a list of all association types available between two objects | key: listAssociationTypes

InputDefaultNotesExample
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
From Object Type
string
/ Required
fromObjectType
The type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
contact
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000
To Object Type
string
/ Required
toObjectType
The type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
deal

{
  "data": {
    "results": [
      {
        "name": "contact_to_company",
        "id": "1"
      }
    ]
  }
}

List Companies​

Retrieve a list of all companies | key: listCompanies

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": 12345,
        "properties": {
          "createdate": "2021-09-14T@@:36:404Z",
          "domain": null,
          "hs_lastmodifieddate": "2021-09-14T@@:36:404Z",
          "hs_object_id": 12345,
          "name": "Example Company"
        },
        "pipeline": "default",
        "createdAt": "2021-09-14T@@:36:404Z",
        "updatedAt": "2021-09-14T@@:36:404Z",
        "archived": false
      }
    ],
    "paging": {
      "next": {
        "after": "123456789",
        "link": "https://api.hubapi.com/crm/v3/objects/products?limit=1&after=123456789"
      }
    }
  }
}

List Contacts​

Retrieve a list of all contacts | key: listContacts

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": 12345,
        "properties": {
          "createdate": "2021-09-14T@@:36:404Z",
          "email": "someone@example.com",
          "firstname": "John",
          "hs_lastmodifieddate": "2021-09-14T@@:36:404Z",
          "lastname": "Doe",
          "hs_object_id": 12345
        },
        "pipeline": "default",
        "createdAt": "2021-09-14T@@:36:404Z",
        "updatedAt": "2021-09-14T@@:36:404Z",
        "archived": false
      }
    ],
    "paging": {
      "next": {
        "after": "123456789",
        "link": "https://api.hubapi.com/crm/v3/objects/products?limit=1&after=123456789"
      }
    }
  }
}

List Custom Objects​

Retrieve all custom objects | key: listCustomObjects

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Return Archived Results
boolean
archived
false
Whether to return only results that have been archived.
 
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": "123456",
        "createdAt": "2020-02-20T18:07:11.390Z",
        "updatedAt": "2020-02-20T18:09:07.555Z",
        "properties": [
          {
            "updatedAt": "2020-02-20T18:07:11.802Z",
            "createdAt": "2020-02-20T18:07:11.802Z",
            "name": "my_object_property",
            "label": "My object property",
            "type": "string",
            "fieldType": "text",
            "groupName": "my_object_information",
            "displayOrder": -1,
            "calculated": false,
            "externalOptions": false,
            "archived": false,
            "hasUniqueValue": false
          }
        ],
        "associations": [
          {
            "id": "123",
            "fromObjectTypeId": "2-123456",
            "toObjectTypeId": "0-1",
            "name": "my_object_to_contact"
          }
        ],
        "labels": {
          "singular": "My object",
          "plural": "My objects"
        },
        "requiredProperties": [
          "my_object_property"
        ],
        "searchableProperties": [
          "my_object_property"
        ],
        "primaryDisplayProperty": "my_object_property",
        "metaType": "PORTAL_SPECIFIC",
        "fullyQualifiedName": "p7878787_my_object\"",
        "name": "my_object"
      }
    ]
  }
}

List Deals​

Retrieve a list of all deals | key: listDeals

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": 12345,
        "properties": {
          "amount": "600.00",
          "closedate": "2021-09-14T@@:36:404Z",
          "createdate": "2021-09-14T@@:36:404Z",
          "dealname": "My Example Deal",
          "dealstage": "presentationscheduled",
          "hs_lastmodifieddate": "2021-09-14T@@:36:404Z",
          "hs_object_id": 12345
        },
        "pipeline": "default",
        "createdAt": "2021-09-14T@@:36:404Z",
        "updatedAt": "2021-09-14T@@:36:404Z",
        "archived": false
      }
    ],
    "paging": {
      "next": {
        "after": "123456789",
        "link": "https://api.hubapi.com/crm/v3/objects/products?limit=1&after=123456789"
      }
    }
  }
}

List Engagements​

List engagement objects from HubSpot CRM, including communications, emails, calls, meetings, notes, postal mail, and tasks. | key: listEngagements

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Properties To Return
string
Value List
propertiesToReturn
Properties to be returned in the response. If the specified property is not present on the requested object, it will be ignored.
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": [
    {
      "id": "47231018154",
      "properties": {
        "hs_createdate": "2024-02-12T01:42:51.758Z",
        "hs_lastmodifieddate": "2024-02-12T01:42:51.950Z",
        "hs_object_id": "47231018154"
      },
      "createdAt": "2024-02-12T01:42:51.758Z",
      "updatedAt": "2024-02-12T01:42:51.950Z",
      "archived": false
    },
    {
      "id": "47231018317",
      "properties": {
        "hs_createdate": "2024-02-12T01:43:03.422Z",
        "hs_lastmodifieddate": "2024-02-12T01:43:03.891Z",
        "hs_object_id": "47231018317"
      },
      "createdAt": "2024-02-12T01:43:03.422Z",
      "updatedAt": "2024-02-12T01:43:03.891Z",
      "archived": false
    }
  ]
}

List Line Items​

Retrieve a list of all line items | key: listLineItems

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": 12345,
        "properties": {
          "amount": "600.00",
          "createdate": "2021-09-14T@@:36:404Z",
          "hs_lastmodifieddate": "2021-09-14T@@:36:404Z",
          "hs_object_id": 12345,
          "hs_product_id": 12345,
          "quantity": null
        }
      }
    ],
    "paging": {
      "next": {
        "after": "123456789",
        "link": "https://api.hubapi.com/crm/v3/objects/products?limit=1&after=123456789"
      }
    }
  }
}

List Products​

Retrieve a list of all products | key: listProducts

InputDefaultNotesExample
Additional Properties To Return
string
Value List
additionalProperties
For each item, provide a property you would like to be returned in the response.
phone
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Return Archived Results
boolean
/ Required
archived
false
Whether to return only results that have been archived.
 
Associations List
string
Value List
associationsList
For each item, provide an object type to retrieve the associated Ids for.
Contacts
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "id": 12345,
        "properties": {
          "createdate": "2021-09-14T@@:36:404Z",
          "hs_lastmodifieddate": "2021-09-14T@@:36:404Z",
          "hs_object_id": 12345,
          "name": "Example Product",
          "price": "6000.00"
        }
      }
    ],
    "paging": {
      "next": {
        "after": "123456789",
        "link": "https://api.hubapi.com/crm/v3/objects/products?limit=1&after=123456789"
      }
    }
  }
}

List Properties​

Retrieve a list of all configured object properties. | key: listProperties

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Object Type
string
/ Required
objectType
Provide a string value for the type of object
deal
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": [
      {
        "createdUserId": "string",
        "hidden": false,
        "modificationMetadata": {
          "readOnlyOptions": true,
          "readOnlyValue": true,
          "readOnlyDefinition": true,
          "archivable": true
        },
        "displayOrder": 2,
        "description": "string",
        "showCurrencySymbol": true,
        "label": "My Contact Property",
        "type": "enumeration",
        "hubspotDefined": true,
        "formField": true,
        "createdAt": "2024-02-27T00:33:18.016Z",
        "archivedAt": "2024-02-27T00:33:18.016Z",
        "archived": true,
        "groupName": "contactinformation",
        "referencedObjectType": "string",
        "name": "my_contact_property",
        "options": [
          {
            "hidden": false,
            "displayOrder": 1,
            "description": "Choice number one",
            "label": "Option A",
            "value": "A"
          }
        ],
        "calculationFormula": "string",
        "hasUniqueValue": false,
        "fieldType": "select",
        "updatedUserId": "string",
        "calculated": true,
        "externalOptions": true,
        "updatedAt": "2024-02-27T00:33:18.016Z"
      }
    ]
  }
}

List Webhooks​

List all webhooks for a server | key: listWebhooks

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": [
    {
      "createdAt": "2024-02-16T20:53:52.503Z",
      "propertyName": "string",
      "active": true,
      "eventType": "contact.propertyChange",
      "id": "string",
      "updatedAt": "2024-02-16T20:53:52.503Z"
    }
  ]
}

Raw Request​

Send raw HTTP request to Hubspot | key: rawRequest

InputDefaultNotesExample
Connection
connection
/ Required
connection
 
 
 
Data
string
data
The HTTP body payload to send to the URL.
{"exampleKey": "Example Data"}
Debug Request
boolean
debugRequest
false
Enabling this flag will log out the current request.
 
File Data
string
Key Value List
fileData
File Data to be sent as a multipart form upload.
[{key: "example.txt", value: "My File Contents"}]
File Data File Names
string
Key Value List
fileDataFileNames
File names to apply to the file data inputs. Keys must match the file data keys above.
 
Form Data
string
Key Value List
formData
The Form Data to be sent as a multipart form upload.
[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header
string
Key Value List
headers
A list of headers to send with the request.
User-Agent: curl/7.64.1
Max Retry Count
string
maxRetries
0
The maximum number of retries to attempt. Specify 0 for no retries.
 
Method
string
/ Required
method
The HTTP method to use.
 
Query Parameter
string
Key Value List
queryParams
A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
 
Response Type
string
/ Required
responseType
json
The type of data you expect in the response. You can request json, text, or binary data.
 
Retry On All Errors
boolean
retryAllErrors
false
If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.
 
Retry Delay (ms)
string
retryDelayMS
0
The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.
 
Timeout
string
timeout
The maximum time that a client will await a response to its request
2000
URL
string
/ Required
url
Input the path only (/crm/v3/objects/deals), The base URL is already included (https://api.hubapi.com). For example, to connect to https://api.hubapi.com/crm/v3/objects/deals, only /crm/v3/objects/deals is entered in this field.
/crm/v3/objects/deals
Use Exponential Backoff
boolean
useExponentialBackoff
false
Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.
 

This action allows you to make requests to any Hubspot API endpoint. This is especially helpful for search endpoints, where objects may have custom properties that are unique to your customers.

The data that you send to Hubspot can be dynamically generated in a code step. Then, you can pass the code step's results as an input reference to the Data input. For example, if you are using Hubspot's search API to search for Hubspot "deals" that have the name "Sample Deal" and are valued less than 100 dollars, you can create a code step that reads like this:

module.exports = async ({ logger, configVars }, stepResults) => {
    const data = {
        filterGroups: [
            {
                filters: [
                    {
                        propertyName: "dealname",
                        operator: "EQ",
                        value: "Sample Deal",
                    },
                    {
                        propertyName: "amount",
                        operator: "LT",
                        value: "100",
                    },
                ],
            },
        ],
        properties: [
            "hs_object_id",
            "createdate",
            "hubspot_owner_id",
            "dealstage",
            "amount",
            "dealname",
            "closedate",
            "days_to_close",
            "hs_analytics_source",
            "hs_analytics_source_data_1",
            "hs_analytics_source_data_2",
            "hs_campaign",
            "hs_closed_amount",
            "hs_lastmodifieddate",
            "dealtype",
            "description",
        ],
    };

    return { data };
};

On the raw request step, enter /crm/v3/objects/deals/search as the URL input, POST as the Method, and reference the code step's results as the Data input.

Read Association​

Get the Ids of the objects associated with those specified in the step | key: readAssociations

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
From Object Type
string
/ Required
fromObjectType
The type of the "from" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
contact
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000
To Id
string
/ Required
toId
Provide a value for the unique identifier of the second object
890435
To Object Type
string
/ Required
toObjectType
The type of the "to" object. Choose from "Contacts", "Companies", "Deals", "Tickets", "Calls", "Quotes", "Line_items", "Meetings", "Products", "Feedback_submissions", or a custom object you have defined.
deal

{
  "data": {
    "completedAt": "2024-02-26T23:59:28.283Z",
    "requestedAt": "2024-02-26T23:59:28.283Z",
    "startedAt": "2024-02-26T23:59:28.283Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "results": [
      {
        "from": {
          "id": "37295"
        },
        "paging": {
          "next": {
            "link": "string",
            "after": "string"
          },
          "prev": {
            "before": "string",
            "link": "string"
          }
        },
        "to": [
          {
            "id": "172859",
            "type": "contact_to_company"
          }
        ]
      }
    ],
    "status": "PENDING"
  }
}

Use the search endpoints to filter, sort, and search objects, records, and engagements across your CRM. | key: search

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Object Type
string
objectType
The type of object to search for. Required for the Custom objects search endpoint.
deal
Search Endpoint
string
/ Required
searchEndpoint
The endpoint to search for objects or engagements. For Custom objects don't forget to fill the Object Type input.
 
Search Properties
code
searchProperties
Include properties such as filters and sorts, or specify the properties to be returned. If empty, only the default properties will be returned. For more information, see https://developers.hubspot.com/docs/api/crm/search.
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "results": {
      "total": 2,
      "results": [
        {
          "id": "651",
          "properties": {
            "createdate": "2023-12-22T16:37:23.758Z",
            "email": "example@email.com",
            "firstname": "John",
            "hs_object_id": "651",
            "lastmodifieddate": "2024-02-25T19:39:45.324Z",
            "lastname": "Doe"
          },
          "createdAt": "2023-12-22T16:37:23.758Z",
          "updatedAt": "2024-02-25T19:39:45.324Z",
          "archived": false
        }
      ],
      "paging": {
        "next": {
          "after": "1"
        }
      }
    }
  }
}

Search Deals​

Returns a list of deals that match the given properties | key: searchDeals

InputDefaultNotesExample
Start After
string
after
Specify the pagination token that's returned by a previous request to retrieve the next page of results
lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Limit
string
limit
Provide a number for the maximum amount of items that will be returned by the search.
100
Operator
string
/ Required
operator
Provide a string value for the operator used to search on.
 
Property Name
string
/ Required
propertyName
Provide a string value for the property you would like to search on. Please ensure the spelling and capitalization are correct for the property you want to use.
dealname
Timeout
string
timeout
The maximum time a client will await a request
20000
Value
string
/ Required
value
Provide a string value corresponding to the given property name
myDeal

{
  "data": {
    "total": 0,
    "paging": {
      "next": {
        "link": "?after=NTI1Cg%3D%3D",
        "after": "NTI1Cg%3D%3D"
      }
    },
    "results": [
      {
        "createdAt": "2024-02-27T00:24:54.571Z",
        "archived": false,
        "archivedAt": "2024-02-27T00:24:54.571Z",
        "propertiesWithHistory": {
          "additionalProp1": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-27T00:24:54.571Z"
            }
          ],
          "additionalProp2": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-27T00:24:54.571Z"
            }
          ],
          "additionalProp3": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-27T00:24:54.571Z"
            }
          ]
        },
        "id": "512",
        "properties": {
          "property_date": "1572480000000",
          "property_radio": "option_1",
          "property_number": "17",
          "property_string": "value",
          "property_checkbox": "false",
          "property_dropdown": "choice_b",
          "property_multiple_checkboxes": "chocolate;strawberry"
        },
        "updatedAt": "2024-02-27T00:24:54.571Z"
      }
    ]
  }
}

Update Batch Contacts​

Update a batch of contacts | key: updateBatchContacts

InputDefaultNotesExample
Batch Contacts
code
/ Required
batchInputs
An array of contact objects to update. See https://developers.hubspot.com/docs/api/crm/contacts for properties.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "completedAt": "2024-02-21T08:27:09.462Z",
    "requestedAt": "2024-02-21T08:27:09.462Z",
    "startedAt": "2024-02-21T08:27:09.462Z",
    "links": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "results": [
      {
        "createdAt": "2024-02-21T08:27:09.462Z",
        "archived": false,
        "archivedAt": "2024-02-21T08:27:09.462Z",
        "propertiesWithHistory": {
          "additionalProp1": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.462Z"
            }
          ],
          "additionalProp2": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.462Z"
            }
          ],
          "additionalProp3": [
            {
              "sourceId": "string",
              "sourceType": "string",
              "sourceLabel": "string",
              "updatedByUserId": 0,
              "value": "string",
              "timestamp": "2024-02-21T08:27:09.462Z"
            }
          ]
        },
        "id": "512",
        "properties": {
          "property_date": "1572480000000",
          "property_radio": "option_1",
          "property_number": "17",
          "property_string": "value",
          "property_checkbox": "false",
          "property_dropdown": "choice_b",
          "property_multiple_checkboxes": "chocolate;strawberry"
        },
        "updatedAt": "2024-02-21T08:27:09.462Z"
      }
    ],
    "status": "PENDING"
  }
}

Update Batch Engagement​

Updates a batch of selected engagements. | key: updateBatchEngagement

InputDefaultNotesExample
Batch Engagements
code
/ Required
batchInputs
An array of engagement objects to update. Each engagement object must contain the required properties for the specified engagement type. See https://developers.hubspot.com/docs/api/crm/tasks for more information.
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "status": "COMPLETE",
    "results": [
      {
        "id": "12345678",
        "properties": {
          "hs_body_preview": "Updated",
          "hs_body_preview_html": "<html>\n <head></head>\n <body>\n Updated\n </body>\n</html>",
          "hs_body_preview_is_truncated": "false",
          "hs_createdate": "2024-02-14T02:31:49.230Z",
          "hs_lastmodifieddate": "2024-02-14T02:31:49.651Z",
          "hs_object_id": "12345678",
          "hs_pipeline_stage": "dd5826e4-c976-4654-a527-b59ada12345",
          "hs_task_body": "Updated"
        },
        "createdAt": "2024-02-14T02:31:49.230Z",
        "updatedAt": "2024-02-14T02:31:49.651Z",
        "archived": false
      }
    ],
    "startedAt": "2024-02-14T02:31:49.629Z",
    "completedAt": "2024-02-14T02:31:49.703Z"
  }
}

Update Company​

Update the information and metadata of an existing company | key: updateCompany

InputDefaultNotesExample
City
string
city
Provide a string value for the city of the company
Atherton
Company Id
string
/ Required
companyId
Provide a value for the unique identifier of the company.
097829
Phone
string
companyPhone
Provide a value for the phone number of the company.
(800) 555-1515
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Description
string
description
Provide the description of the object.
This is an example description.
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Industry
string
industry
Provide a string value for the industry of the company
Software
State
string
state
Provide a string value for the state of the company
California
Timeout
string
timeout
The maximum time a client will await a request
20000
Company Name
string
updateCompanyName
Provide a string value for the name of the company
Acme Inc.
Domain
string
updateDomain
Provide a string value for the domain of the company
www.example.com

{
  "data": {
    "createdAt": "2024-02-27T00:06:42.336Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:06:42.336Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.336Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.336Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:06:42.336Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:06:42.336Z"
  }
}

Update Contact​

Update the information and metadata of an existing contact | key: updateContact

InputDefaultNotesExample
Contact Id
string
/ Required
contactId
Provide a string value for the unique identifier of the contact.
9989223
Company
string
contactUpdateCompany
Provide a string value for the company of the contact
Acme Inc.
Email
string
contactUpdateEmail
Provide a string value for the email of the contact
someone@example.com
First Name
string
contactUpdateFirstName
Provide a string value for the first name of the contact
John
Last Name
string
contactUpdatelastName
Provide a string value for the last name of the contact
Doe
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000
Phone
string
updatePhone
Provide a value for the phone number of the contact
(877) 929-0687
Website
string
updateWebsite
Provide a string value for the website of the contact
www.example.com

{
  "data": {
    "createdAt": "2024-02-27T00:20:24.840Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:20:24.840Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.840Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.840Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:20:24.840Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:20:24.840Z"
  }
}

Update Custom Object​

Updates an object's schema | key: updateCustomObject

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Fully qualified name or object type ID of your schema.
string
/ Required
objectType
Provide a string value for the type of object
deal
Plural Label
string
pluralLabel
The word for multiple objects. (There's no way to change this later.)
My object
Required Properties
string
Value List
requiredProperties
000xxx
The names of properties that should be required when creating an object of this type.
my_object_property
Searchable Properties
string
Value List
searchableProperties
000xxx
Names of properties that will be indexed for this object type in by HubSpot's product search.
my_object_property
Singular Label
string
singularLabel
The word for one object. (There's no way to change this later.)
My object
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "123456",
    "createdAt": "2020-02-20T18:07:11.390Z",
    "updatedAt": "2020-02-20T18:09:07.555Z",
    "properties": [
      {
        "updatedAt": "2020-02-20T18:07:11.802Z",
        "createdAt": "2020-02-20T18:07:11.802Z",
        "name": "my_object_property",
        "label": "My object property",
        "type": "string",
        "fieldType": "text",
        "groupName": "my_object_information",
        "displayOrder": -1,
        "calculated": false,
        "externalOptions": false,
        "archived": false,
        "hasUniqueValue": false
      }
    ],
    "associations": [
      {
        "id": "123",
        "fromObjectTypeId": "2-123456",
        "toObjectTypeId": "0-1",
        "name": "my_object_to_contact"
      }
    ],
    "labels": {
      "singular": "My object",
      "plural": "My objects"
    },
    "requiredProperties": [
      "my_object_property"
    ],
    "searchableProperties": [
      "my_object_property"
    ],
    "primaryDisplayProperty": "my_object_property",
    "metaType": "PORTAL_SPECIFIC",
    "fullyQualifiedName": "p7878787_my_object\"",
    "name": "my_object"
  }
}

Update Deal​

Update the information or metadata of an existing deal | key: updateDeal

InputDefaultNotesExample
Amount
string
amount
Provide a string value for the amount.
34,000
Close Date
string
closeDate
Provide a date representing when the sale will close.
2019-12-07T16:50:06.678Z
Deal Id
string
/ Required
dealId
Provide the unique identifier of the deal
804874
Deal Type
string
dealType
Provide a string value for the type of deal. By default, categorize your deal as either a New Business or Existing Business. The picklist of values for this property is configurable through Hubspot
newbusiness
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Owner Id
string
hubspotOwnerId
Provide a string value for the owner of the resource
910901
Priority
string
priority
Provide a string value for priority of the deal.
 
Timeout
string
timeout
The maximum time a client will await a request
20000
Deal Name
string
updateDealName
Provide a string value for the name of the deal
My Example Deal
Deal Stage
string
updateDealStage
Provide a value for the stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
presentationscheduled
Pipeline
string
updatePipeline
Provide a string value for which pipeline to interact with.
default

{
  "data": {
    "createdAt": "2024-02-27T00:24:54.543Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:24:54.543Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.543Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.543Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:24:54.543Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "property_date": "1572480000000",
      "property_radio": "option_1",
      "property_number": "17",
      "property_string": "value",
      "property_checkbox": "false",
      "property_dropdown": "choice_b",
      "property_multiple_checkboxes": "chocolate;strawberry"
    },
    "updatedAt": "2024-02-27T00:24:54.543Z"
  }
}

Update Engagement​

Update a communication, email, call, meeting, note, postal mail or task engagement in HubSpot CRM. | key: updateEngagement

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Engagement Id
string
/ Required
engagementId
The unique identifier of the engagement. A taskId, meetingId, etc.
123456
Engagement Object
string
/ Required
engagementObject
Select an engagement object.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Id Property
string
idProperty
The name of a property whose values are unique for this object type.
 
Properties
code
/ Required
properties
A properties object to update, attributes depend on the engagement type. For possible properties for each engagement type go to https://developers.hubspot.com/docs/api/crm/tasks.
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": {
    "id": "654321",
    "properties": {
      "hs_body_preview": "changed",
      "hs_body_preview_html": "<html>\n <head></head>\n <body>\n changed\n </body>\n</html>",
      "hs_body_preview_is_truncated": "false",
      "hs_createdate": "2024-02-12T22:04:01.144Z",
      "hs_lastmodifieddate": "2024-02-12T22:04:01.871Z",
      "hs_object_id": "654321",
      "hs_task_body": "changed"
    },
    "createdAt": "2024-02-12T22:04:01.144Z",
    "updatedAt": "2024-02-12T22:04:01.871Z",
    "archived": false
  }
}

Update Line Item​

Update an the information and metadata of an existing line item | key: updateLineItem

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Line Item Id
string
/ Required
lineItemId
Provide the unique identifier of the line item.
78349093
Quantity
string
quantity
Provide a string value for the quantity of product in the line item.
80
Recurring Billing Monthly Rate
string
recurringBillingFrequency
Provide a string value for the quantity of product in the line item.
 
Recurring Billing Frequency
string
recurringBillingPeriod
Provide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
P12M
Timeout
string
timeout
The maximum time a client will await a request
20000
Name
string
updateLineItemName
Provide a string value for the name of the line item.
My line Item
Price
string
updatePrice
Provide the price of the product.
80400
Product Id
string
updateProductId
Provide the unique identifier of the product.
804874

{
  "data": {
    "createdAt": "2024-02-27T00:31:42.485Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:31:42.485Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.485Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.485Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:31:42.485Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "name": "1 year implementation consultation",
      "price": "6000.00",
      "quantity": "2",
      "hs_product_id": "191902",
      "recurringbillingfrequency": "monthly",
      "hs_recurring_billing_period": "P24M"
    },
    "updatedAt": "2024-02-27T00:31:42.485Z"
  }
}

Update Product​

Update the information and metadata of an existing product | key: updateProduct

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Description
string
description
Provide the description of the object.
This is an example description.
Dynamic Fields
code
dynamicValues
A field for dynamic inputs that can be configured at deploy time with the use of a key value config variable.
Values
string
Key Value List
fieldValues
The names of the fields and their values to use when creating/updating a record.
name:My Example Account,phone:5551234567
Connection
connection
/ Required
hubspotConnection
 
 
 
Product Id
string
/ Required
productId
Provide the unique identifier of the product.
804874
Recurring Billing Frequency
string
recurringBillingPeriod
Provide the billing frequency of the product. Specify the integer of months in between a P and M in the following format: P{integer}M
P12M
Timeout
string
timeout
The maximum time a client will await a request
20000
Unit Cost
string
unitCost
Provide the unit cost of the product.
800
Price
string
updatePrice
Provide the price of the product.
80400
Product Name
string
updateProductName
Provide the name of the product.
myProduct
Product SKU
string
updateSku
Provide the SKU of the product.
804874

{
  "data": {
    "createdAt": "2024-02-27T00:35:05.457Z",
    "archived": false,
    "archivedAt": "2024-02-27T00:35:05.457Z",
    "propertiesWithHistory": {
      "additionalProp1": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.457Z"
        }
      ],
      "additionalProp2": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.457Z"
        }
      ],
      "additionalProp3": [
        {
          "sourceId": "string",
          "sourceType": "string",
          "sourceLabel": "string",
          "updatedByUserId": 0,
          "value": "string",
          "timestamp": "2024-02-27T00:35:05.457Z"
        }
      ]
    },
    "id": "512",
    "properties": {
      "name": "Implementation Service",
      "price": "6000.00",
      "hs_sku": "191902",
      "description": "Onboarding service for data product",
      "hs_cost_of_goods_sold": "600.00",
      "hs_recurring_billing_period": "P12M"
    },
    "updatedAt": "2024-02-27T00:35:05.457Z"
  }
}

Validate Connection​

Returns a boolean value that specifies whether the provided Connection is valid | key: validateConnection

InputDefaultNotesExample
Debug Request
boolean
debugRequest
false
Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API.
 
Connection
connection
/ Required
hubspotConnection
 
 
 
Timeout
string
timeout
The maximum time a client will await a request
20000

{
  "data": true
}