Hubspot Component
Manage objects and associations in the Hubspot CRM platform
Component key: hubspot#
DescriptionHubspot is a Customer Relationship Management software for inbound marketing, sales, and customer service. This component allows you to interact with the Hubspot REST API.
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.
#
Hubspot Connections#
Hubspot OAuth 2.0The 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 Auth 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
Input | Default | Notes |
---|---|---|
Input Authorize URL string / Required Hidden Field | Default https://app.hubspot.com/oauth/authorize | Notes The OAuth 2.0 Authorization URL for Hubspot |
Input Client ID string / Required | Default | Notes Provide the Client Id you received from the Hubspot Developer Console. |
Input Client Secret password / Required | Default | Notes Provide the Client Secret you received from the Hubspot Developer Console. |
Input Scopes string / Required | Default | Notes A space-delimited set of one or more scopes to get the user's permission to access. |
Input Token URL string / Required Hidden Field | Default https://api.hubapi.com/oauth/v1/token | Notes The OAuth 2.0 Token URL for Hubspot |
#
Private App Access TokenInput | Notes |
---|---|
Input Access Token string / Required | Notes An access token generated when you create a private app. For testing purposes only - use OAuth 2.0 for production integrations. |
#
Triggers#
WebhookTrigger for handling webhook requests from the Hubspot platform | key: webhook
#
Output Example Payload{ "payload": { "headers": { "accept": "*/*", "Content-Type": "application/json; charset=UTF-8", "User-Agent": "HubSpot Connect 2.0 (http:dev.hubspot.com/) - WebhooksExecutionService-userweb", "Host": "hooks.example.prismatic.io", "X-HS-Internal-Request": "0", "X-HubSpot-Correlation-Id": "exampleID", "X-HubSpot-Signature": "exampleSignature" }, "body": { "data": [ { "eventID": 100, "subscriptionID": 12345, "portalId": 12345, "occurredAt": 123456789, "subscriptionType": "contact.creation", "attemptNumber": 0, "objectId": 123, "changeSource": "CRM", "changeFlag": "NEW" } ] }, "rawBody": { "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] } }, "queryParameters": None, "webhookUrls": { "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA==" }, "webhookApiKeys": { "Flow 1": ["abc-123"] }, "customer": { "externalId": "customer-example-external-id", "name": "John Doe" } }}
#
Actions#
Archive AssociationRemove the associations between two provided objects | key: ArchiveAssociations
Input | Default | Notes | Example |
---|---|---|---|
Input Type Of Association string / Required | Default | Notes 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" | Example 890435 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input From Id string / Required | Default | Notes Provide a value for the unique identifier of the first object | Example 890435 |
Input From Object Type string / Required | Default | Notes 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. | Example contact |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input To Id string / Required | Default | Notes Provide a value for the unique identifier of the second object | Example 890435 |
Input To Object Type string / Required | Default | Notes 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. | Example deal |
#
Create AssociationCreate an association between the objects identified in the step | key: createAssociations
Input | Default | Notes | Example |
---|---|---|---|
Input Type Of Association string / Required | Default | Notes 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" | Example 890435 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input From Id string / Required | Default | Notes Provide a value for the unique identifier of the first object | Example 890435 |
Input From Object Type string / Required | Default | Notes 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. | Example contact |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input To Id string / Required | Default | Notes Provide a value for the unique identifier of the second object | Example 890435 |
Input To Object Type string / Required | Default | Notes 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. | Example deal |
#
Create CompanyCreate a new company | key: createCompany
Input | Default | Notes | Example |
---|---|---|---|
Input City string | Default | Notes Provide a string value for the city of the company | Example Atherton |
Input Company Name string / Required | Default | Notes Provide a string value for the name of the company | Example Acme Inc. |
Input Phone string | Default | Notes Provide a value for the phone number of the company. | Example (800) 555-1515 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Description string | Default | Notes Provide the description of the object. | Example This is an example description. |
Input Domain string | Default | Notes Provide a string value for the domain of the company | Example www.example.com |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Industry string | Default | Notes Provide a string value for the industry of the company | Example Software |
Input State string | Default | Notes Provide a string value for the state of the company | Example California |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Create ContactCreate a new contact | key: CreateContact
Input | Default | Notes | Example |
---|---|---|---|
Input Company string | Default | Notes Provide a string value for the company of the contact | Example Acme Inc. |
Input Email string | Default | Notes Provide a string value for the email of the contact | Example someone@example.com |
Input First Name string / Required | Default | Notes Provide a string value for the first name of the contact | Example John |
Input Last Name string / Required | Default | Notes Provide a string value for the last name of the contact | Example Doe |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Phone string | Default | Notes Provide a value for the phone number. | Example (877) 929-0687 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Website string | Default | Notes Provide a string value for the website. | Example www.example.com |
#
Create DealCreate a new deal | key: createDeal
Input | Default | Notes | Example |
---|---|---|---|
Input Amount string | Default | Notes Provide a string value for the amount. | Example 34,000 |
Input Close Date string | Default | Notes Provide a date representing when the sale will close. | Example 2019-12-07T16:50:06.678Z |
Input Deal Name string / Required | Default | Notes Provide a string value for the name of the deal | Example My Example Deal |
Input Deal Stage string / Required | Default | Notes 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. | Example presentationscheduled |
Input Deal Type string | Default | Notes 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 | Example newbusiness |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Owner Id string | Default | Notes Provide a string value for the owner of the resource | Example 910901 |
Input Pipeline string / Required | Default | Notes Provide a string value for which pipeline to interact with. | Example default |
Input Priority string | Default | Notes Provide a string value for priority of the deal. | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Create Line ItemCreate a new line item | key: createLineItem
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Name string / Required | Default | Notes Provide a string value for the name of the line item. | Example My Line Item |
Input Price string / Required | Default | Notes Provide the price of the product. | Example 80400 |
Input Product Id string / Required | Default | Notes Provide the unique identifier of the product. | Example 804874 |
Input Quantity string | Default | Notes Provide a string value for the quantity of product in the line item. | Example 80 |
Input Recurring Billing Monthly Rate string | Default | Notes Provide a string value for the quantity of product in the line item. | Example |
Input Recurring Billing Frequency string | Default | Notes 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 | Example P12M |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Create ProductCreate a new product | key: createProduct
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Description string | Default | Notes Provide the description of the object. | Example This is an example description. |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Price string / Required | Default | Notes Provide the price of the product. | Example 80400 |
Input Product Name string / Required | Default | Notes Provide the name of the product. | Example myProduct |
Input Recurring Billing Frequency string | Default | Notes 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 | Example P12M |
Input Product SKU string / Required | Default | Notes Provide the SKU of the product. | Example 804874 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Unit Cost string | Default | Notes Provide the unit cost of the product. | Example 800 |
#
Delete CompanyDelete an existing company by Id | key: deleteCompany
Input | Default | Notes | Example |
---|---|---|---|
Input Company Id string / Required | Default | Notes Provide a value for the unique identifier of the company. | Example 097829 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Delete ContactRetrieve a list of all contacts | key: deleteContact
Input | Default | Notes | Example |
---|---|---|---|
Input Contact Id string / Required | Default | Notes Provide a string value for the unique identifier of the contact. | Example 9989223 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Delete DealDelete a deal by its Id | key: deleteDeal
Input | Default | Notes | Example |
---|---|---|---|
Input Deal Id string / Required | Default | Notes Provide the unique identifier of the deal | Example 804874 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Delete Line ItemDelete an existing line item by Id | key: deleteLineItem
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Line Item Id string / Required | Default | Notes Provide the unique identifier of the line item. | Example 78349093 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Delete ProductDelete a product by Id | key: deleteProduct
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Product Id string / Required | Default | Notes Provide the unique identifier of the product. | Example 804874 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get CompanyRetrieve the information or metadata of a company by Id, domain, or name | key: getCompany
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Company Id string | Default | Notes Provide a value for the unique identifier of the company. | Example 097829 |
Input Company Name string | Default | Notes Provide a string value for the name of the company | Example Acme Inc. |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Domain string | Default | Notes Provide a string value for the domain of the company | Example www.example.com |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get ContactGet the information and metadata of a contact by Id or Email | key: getContact
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Email string | Default | Notes Provide a string value for the email of the contact | Example someone@example.com |
Input Contact Id string | Default | Notes Provide a string value for the unique identifier of the contact. | Example 9989223 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get Current UserReturn information about the current session's user. | key: getCurrentUser
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get DealRetrieve information and metadata about a deal by its Id or name | key: getDealById
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Deal Id string | Default | Notes Provide the unique identifier of the deal | Example 804874 |
Input Deal Name string | Default | Notes Provide a string value for the name of the deal | Example My Example Deal |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get Line ItemRetrieve the information and metadata of a line item by Id | key: getLineItem
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Line Item Id string | Default | Notes Provide the unique identifier of the line item. | Example 78349093 |
Input Name string | Default | Notes Provide a string value for the name of the line item. | Example My Line Item |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Get ProductRetrieve the information and metadata of a product by Id or name | key: getProduct
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Product Id string | Default | Notes Provide the unique identifier of the product. | Example 804874 |
Input Product Name string | Default | Notes Provide the name of the product. | Example myProduct |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
List Association TypesRetrieve a list of all association types available between two objects | key: listAssociationTypes
Input | Default | Notes | Example |
---|---|---|---|
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input From Object Type string / Required | Default | Notes 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. | Example contact |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input To Object Type string / Required | Default | Notes 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. | Example deal |
#
List CompaniesRetrieve a list of all companies | key: listCompanies
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Output Example Payload{ "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 ContactsRetrieve a list of all contacts | key: listContacts
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Output Example Payload{ "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 DealsRetrieve a list of all deals | key: listDeals
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Output Example Payload{ "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 Line ItemsRetrieve a list of all line items | key: listLineItems
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Output Example Payload{ "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 ProductsRetrieve a list of all products | key: listProducts
Input | Default | Notes | Example |
---|---|---|---|
Input Additional Properties To Return string Value List | Default | Notes For each item, provide a property you would like to be returned in the response. | Example phone |
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Return Archived Results boolean / Required | Default false | Notes Whether to return only results that have been archived. | Example |
Input Associations List string Value List | Default | Notes For each item, provide an object type to retrieve the associated Ids for. | Example Contacts |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Output Example Payload{ "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 PropertiesRetrieve a list of all configured object properties. | key: listProperties
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Object Type string / Required | Default | Notes Provide a string value for the type of object | Example deal |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
#
Raw RequestSend a raw request to Hubspot | key: rawRequest
Input | Default | Notes | Example |
---|---|---|---|
Input Connection connection / Required | Default | Notes | Example |
Input Data string | Default | Notes The HTTP body payload to send to the URL. | Example {"exampleKey": "Example Data"} |
Input Debug Request boolean | Default false | Notes Enabling this flag will log out the current request. | Example |
Input File Data string Key Value List | Default | Notes File Data to be sent as a multipart form upload. | Example [{key: "example.txt", value: "My File Contents"}] |
Input Form Data string Key Value List | Default | Notes The Form Data to be sent as a multipart form upload. | Example [{"key": "Example Key", "value": new Buffer("Hello World")}] |
Input Header string Key Value List | Default | Notes A list of headers to send with the request. | Example User-Agent: curl/7.64.1 |
Input Max Retry Count string | Default 0 | Notes The maximum number of retries to attempt. | Example |
Input Method string / Required | Default | Notes The HTTP method to use. | Example |
Input Query Parameter string Key Value List | Default | Notes 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. | Example |
Input Response Type string / Required | Default json | Notes The type of data you expect in the response. You can request json, text, or binary data. | Example |
Input Retry On All Errors boolean | Default false | Notes If true, retries on all erroneous responses regardless of type. | Example |
Input Retry Delay (ms) string | Default 0 | Notes The delay in milliseconds between retries. | Example |
Input Timeout string | Default | Notes The maximum time that a client will await a response to its request | Example 2000 |
Input URL string / Required | Default | Notes This is the URL to call. | Example /crm/v3/objects/deals |
Input Use Exponential Backoff boolean | Default false | Notes Specifies whether to use a pre-defined exponential backoff strategy for retries. | Example |
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 AssociationGet the Ids of the objects associated with those specified in the step | key: readAssociations
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input From Object Type string / Required | Default | Notes 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. | Example contact |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input To Id string / Required | Default | Notes Provide a value for the unique identifier of the second object | Example 890435 |
Input To Object Type string / Required | Default | Notes 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. | Example deal |
#
Search DealsReturns a list of deals that match the given properties | key: searchDeals
Input | Default | Notes | Example |
---|---|---|---|
Input Start After string | Default | Notes Specify the pagination token that's returned by a previous request to retrieve the next page of results | Example lslTXFcbLQKkb0vP9Kgh5hy0Y0OnC7Z9ZPHPwPmMnxSk3eiDRMkct7D8E |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Limit string | Default | Notes Provide a number for the maximum amount of items that will be returned by the search. | Example 100 |
Input Operator string / Required | Default | Notes Provide a string value for the operator used to search on. | Example |
Input Property Name string / Required | Default | Notes 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. | Example dealname |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Value string / Required | Default | Notes Provide a string value corresponding to the given property name | Example myDeal |
#
Update CompanyUpdate the information and metadata of an existing company | key: updateCompany
Input | Default | Notes | Example |
---|---|---|---|
Input City string | Default | Notes Provide a string value for the city of the company | Example Atherton |
Input Company Id string / Required | Default | Notes Provide a value for the unique identifier of the company. | Example 097829 |
Input Phone string | Default | Notes Provide a value for the phone number of the company. | Example (800) 555-1515 |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Description string | Default | Notes Provide the description of the object. | Example This is an example description. |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Industry string | Default | Notes Provide a string value for the industry of the company | Example Software |
Input State string | Default | Notes Provide a string value for the state of the company | Example California |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Company Name string | Default | Notes Provide a string value for the name of the company | Example Acme Inc. |
Input Domain string | Default | Notes Provide a string value for the domain of the company | Example www.example.com |
#
Update ContactUpdate the information and metadata of an existing contact | key: updateContact
Input | Default | Notes | Example |
---|---|---|---|
Input Contact Id string / Required | Default | Notes Provide a string value for the unique identifier of the contact. | Example 9989223 |
Input Company string | Default | Notes Provide a string value for the company of the contact | Example Acme Inc. |
Input Email string | Default | Notes Provide a string value for the email of the contact | Example someone@example.com |
Input First Name string | Default | Notes Provide a string value for the first name of the contact | Example John |
Input Last Name string | Default | Notes Provide a string value for the last name of the contact | Example Doe |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Phone string | Default | Notes Provide a value for the phone number of the contact | Example (877) 929-0687 |
Input Website string | Default | Notes Provide a string value for the website of the contact | Example www.example.com |
#
Update DealUpdate the information or metadata of an existing deal | key: updateDeal
Input | Default | Notes | Example |
---|---|---|---|
Input Amount string | Default | Notes Provide a string value for the amount. | Example 34,000 |
Input Close Date string | Default | Notes Provide a date representing when the sale will close. | Example 2019-12-07T16:50:06.678Z |
Input Deal Id string / Required | Default | Notes Provide the unique identifier of the deal | Example 804874 |
Input Deal Type string | Default | Notes 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 | Example newbusiness |
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Owner Id string | Default | Notes Provide a string value for the owner of the resource | Example 910901 |
Input Priority string | Default | Notes Provide a string value for priority of the deal. | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Deal Name string | Default | Notes Provide a string value for the name of the deal | Example My Example Deal |
Input Deal Stage string | Default | Notes 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. | Example presentationscheduled |
Input Pipeline string | Default | Notes Provide a string value for which pipeline to interact with. | Example default |
#
Update Line ItemUpdate an the information and metadata of an existing line item | key: updateLineItem
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Line Item Id string / Required | Default | Notes Provide the unique identifier of the line item. | Example 78349093 |
Input Quantity string | Default | Notes Provide a string value for the quantity of product in the line item. | Example 80 |
Input Recurring Billing Monthly Rate string | Default | Notes Provide a string value for the quantity of product in the line item. | Example |
Input Recurring Billing Frequency string | Default | Notes 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 | Example P12M |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Name string | Default | Notes Provide a string value for the name of the line item. | Example My line Item |
Input Price string | Default | Notes Provide the price of the product. | Example 80400 |
Input Product Id string | Default | Notes Provide the unique identifier of the product. | Example 804874 |
#
Update ProductUpdate the information and metadata of an existing product | key: updateProduct
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Description string | Default | Notes Provide the description of the object. | Example This is an example description. |
Input Values string Key Value List | Default | Notes The names of the fields and their values to use when creating/updating a record. Hubspot allows you to configure many different properties to your CRM object. You can use this input to specify the key and value of any property that is not already in Prismatic. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Product Id string / Required | Default | Notes Provide the unique identifier of the product. | Example 804874 |
Input Recurring Billing Frequency string | Default | Notes 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 | Example P12M |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |
Input Unit Cost string | Default | Notes Provide the unit cost of the product. | Example 800 |
Input Price string | Default | Notes Provide the price of the product. | Example 80400 |
Input Product Name string | Default | Notes Provide the name of the product. | Example myProduct |
Input Product SKU string | Default | Notes Provide the SKU of the product. | Example 804874 |
#
Validate ConnectionReturns a boolean value that specifies whether the provided Connection is valid | key: validateConnection
Input | Default | Notes | Example |
---|---|---|---|
Input Debug Request boolean | Default false | Notes Flipping this flag will enable the logging of the entire request, before it is sent to the Hubspot API. | Example |
Input Connection connection / Required | Default | Notes | Example |
Input Timeout string | Default | Notes The maximum time a client will await a request | Example 20000 |