HubSpot V3 – Custom Objects

General Custom Field Handling

The HubSpot V3 Connector takes advantage of the HubSpot API’s schema features, by retrieving details of properties and their data types to automatically add them to Connector Methods working with objects such as Companies, Contacts, Deals, and Products using Cyclr’s Dynamic Custom Fields feature. This is often used by Cyclr’s Connectors where an external API exposes that information.

HubSpot Validation Rules

While Cyclr is able to retrieve HubSpot properties and data types, retrieving details of validation rules defined within HubSpot requires further calls to the HubSpot API, which makes that unfeasible to include when automatically adding Custom Fields.

To obtain details of HubSpot validation rules, you can use the provided “Get Property Validation Rules” Method which can be found in the “Object Properties” Method Category, under “Core”. You could call that manually on the Connector Settings page or through the Cyclr API using Data on Demand to understand values that would be acceptable.

The “Get Property Validation Rules” Method retrieves all validation rules for a given HubSpot property.

Create a Custom Object Schema within HubSpot

To create custom object categories in the Cyclr HubSpot V3 Connector, you need a HubSpot “custom object schema”. HubSpot explains how to create custom object schemas on the Custom objects page of their documentation. You can create custom object schema on the Object schema tab under Create a new schema.

Create a Custom Object Method Category within Cyclr

You can then create a Custom Object Method Category on a HubSpot V3 Connector:

  1. Go to the “Connector Settings” page of the particular instance of the HubSpot V3 Connector.
  2. Under the Methods and Fields heading, expand the Custom Objects category.
  3. Select the Copy this Category to create a Custom Object Category icon in the top right if the category to open a popup.
  4. Use the drop-down menu shown in that popup to select the custom object schema to use for the custom object method category.
  5. Select Copy to create it on the Connector.

The new Method Category will use the custom object schema you selected for all of its Methods.