HubSpot

The HubSpot connector lets you perform insert, delete, update, and read operations on HubSpot dataset.

Supported versions

This connector supports the following HubSpot API versions:

HubSpot
HubSpotV3
HubSpotV4

Before you begin

Before using the HubSpot connector, do the following tasks:

In your Google Cloud project:
- Grant the roles/connectors.admin IAM role to the user configuring the connector.
- Grant the following IAM roles to the service account that you want to use for the connector:
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  A service account is a special type of Google account intended to represent a non-human user that needs to authenticate and be authorized to access data in Google APIs. If you don't have a service account, you must create a service account. For more information, see Creating a service account.
- Enable the following services:
  - secretmanager.googleapis.com (Secret Manager API)
  - connectors.googleapis.com (Connectors API)
  To understand how to enable services, see Enabling services.
If these services or permissions have not been enabled for your project previously, you are prompted to enable them when configuring the connector.

Configure the connector

Configuring the connector requires you to create a connection to your data source (backend system). A connection is specific to a data source. It means that if you have many data sources, you must create a separate connection for each data source. To create a connection, do the following steps:

In the Cloud console, go to the Integration Connectors > Connections page and then select or create a Google Cloud project.
Go to the Connections page
Click + Create new to open the Create Connection page.
In the Location section, choose the location for the connection.
1. Region: Select a location from the drop-down list.
  Supported regions for connectors include:
  For the list of all the supported regions, see Locations.
2. Click Next.
In the Connection Details section, complete the following:
1. Connector: Select HubSpot from the drop down list of available Connectors.
2. Connector version: Select the Connector version from the drop down list of available versions.
3. In the Connection Name field, enter a name for the Connection instance.
  Connection names must meet the following criteria:
  - Connection names can use letters, numbers, or hyphens.
  - Letters must be lower-case.
  - Connection names must begin with a letter and end with a letter or number.
  - Connection names cannot exceed 63 characters.
4. Optionally, enter a Description for the connection instance.
5. Service Account: Select a service account that has the required roles.
6. To use the connection for event subscriptions, select Enable event subscription. Selecting this, displays the following options:
  - Enable event subscription with entity and actions: Select this option to use the connection for both event subscription and connector operations (entities and actions).
  - Enable only event subscription: Select this option to use the connection only for event subscription.
  For both these selections, you are prompted to configure the event details in the subsequent steps.
7. Schema: Specify the HubSpot API version to use. HubSpotV4 is the new API.
8. BrowsableSchemas: This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
9. Contacts Properties: Enter the comma separated field names of the Contacts entity that you want to select from the List entity operation. For example, fieldA, fieldB, fieldC
10. Companies Properties: Enter the comma separated field names of the Companies entity that you want to select from the List entity operation. For example, fieldA, fieldB, fieldC
11. Deals Properties: Enter the comma separated field names of the Deals entity that you want to select from the List entity operation. For example, fieldA, fieldB, fieldC
12. Use proxy: Select this checkbox to configure a proxy server for the connection.
13. Proxy Auth Scheme: The authentication type to use to authenticate to the ProxyServer proxy.
14. Proxy User: A user name to be used to authenticate to the ProxyServer proxy.
15. Proxy Password: A password to be used to authenticate to the ProxyServer proxy.
16. Proxy SSL Type: The SSL type to use when connecting to the ProxyServer proxy.
17. Optionally, configure the Connection node settings:
  - Minimum number of nodes: Enter the minimum number of connection nodes.
  - Maximum number of nodes: Enter the maximum number of connection nodes.
  A node is a unit (or replica) of a connection that processes transactions. More nodes are required to process more transactions for a connection and conversely, fewer nodes are required to process fewer transactions. To understand how the nodes affect your connector pricing, see Pricing for connection nodes. If you don't enter any values, by default the minimum nodes are set to 2 (for better availability) and the maximum nodes are set to 50.
18. Optionally, click + Add label to add a label to the Connection in the form of a key/value pair.
19. Click Next.
In the Destinations section, enter details of the remote host (backend system) you want to connect to.
1. Destination Type: You can specify the destination details either as a host address or a service attachment. Select any of the following destination types:
  - Host address: If you want to specify the hostname or IP address of the destination.
  - Service attachment: If you want to specify the private endpoint for your internal IP addresses. The service attachment, lets you hide your internal IP addresses from the external network. You can create a service attachment in Google Cloud, by using the Private Service Connect feature. For information on configuring a Private Service Connect, see Publish managed services.
  Based on your selection of destination type, enter the host address or the service attachment name.
  
  To enter additional destinations, click +Add destination.
2. Click Next.
In the Authentication section, enter the authentication details.
1. Select an Authentication type and enter the relevant details.
  The following authentication types are supported by the HubSpot connection:
  - Private App Access Token: Select the Secret Manager Secret containing the private app access token.
    Private apps allow you to use HubSpot's APIs to access specific data from your HubSpot account. You can authorize what each private app can request or change in your account, which will generate an access token that's unique to your private app. In your private app, ensure you have provided the read permission at least to the following scopes:
    - crm.schemas.line_items.read
    - crm.schemas.quotes.read
    - crm.schemas.deals.read
    - crm.schemas.companies.read
    - crm.schemas.custom.read
    - crm.schemas.contacts.read
    For more information, see Private apps.
2. Click Next.
If you have enabled event subscription, the Event Subscription Details section appears on the connection creation page. In the Event subscription details step, provide the authentication details that will be used to validate the HubSpot token payload:
1. Client Secret: (Optional) Select the Secret Manager secret of your private app's client secret, and the corresponding secret version from the Secret Version drop-down.
2. Select Enable private connectivity for secured connectivity between your backend application and your connection. If you select this option, you must perform additional configuration steps after creating the connection. For more information, see Private connectivity for event subscription.
3. Enter the dead-letter configuration. If you configure dead-letter, the connection writes the unprocessed events to the specified Pub/Sub topic. Enter the following details:
  1. Dead-letter project ID: The Google Cloud project ID where you have configured the dead-letter Pub/Sub topic.
  2. Dead-letter topic: The Pub/Sub topic where you want to write the details of the unprocessed event.
4. Click Next.
Review: Review your connection and authentication details.
Click Create.

Entities, operations, and actions

All the Integration Connectors provide a layer of abstraction for the objects of the connected application. You can access an application's objects only through this abstraction. The abstraction is exposed to you as entities, operations, and actions.

Entity: An entity can be thought of as an object, or a collection of properties, in the connected application or service. The definition of an entity differs from a connector to a connector. For example, in a database connector, tables are the entities, in a file server connector, folders are the entities, and in a messaging system connector, queues are the entities.
However, it is possible that a connector doesn't support or have any entities, in which case the Entities list will be empty.
Operation: An operation is the activity that you can perform on an entity. You can perform any of the following operations on an entity:
- List
- Get
- Create
- Update
- Delete
Selecting an entity from the available list, generates a list of operations available for the entity. For a detailed description of the operations, see the Connectors task's entity operations. However, if a connector doesn't support any of the entity operations, such unsupported operations aren't listed in the Operations list.
Action: An action is a first class function that is made available to the integration through the connector interface. An action lets you make changes to an entity or entities, and vary from connector to connector. However, it is possible that a connector doesn't support any action, in which case the Actions list will be empty.

Known issues

The update operation on some of the entities returns an empty response even though the update is successful. In such cases, it's recommended to verify the update in your HubSpot instance.
In HubSpot, you can potentially have many custom fields for the following entities:
- Contacts
- Companies
- Deals
For these entities, selecting all the fields at once in the List entity operation, may cause the HubSpot connector to return an error. In the scenarios where you want to limit the number of custom fields from the List operation, specify the required field names (as comma separated values) in the HubSpot connector configuration. For example, to limit the fields of the Contacts entity, specify the required field names in the connector configuration's Contacts Properties field. Similarly, for the Companies entity, specify the required field names in the Companies Properties field, and for the Deals entity, specify the required field names in the Deals Properties field.

You can specify the fields during the connection creation step. However, if you already have an existing connection, you must edit the connection, and then specify the required fields.
If you have a very large result set, the List operation might fail because of a connection timeout. In such a scenario, you can explore the option of limiting your result set by specifying the filter clause for the List operation.

Entity operation examples

This section shows how to perform some of the entity operations in this connector.

Example - List all the contacts

This example lists all the records in the Contacts entity.

In the Configure connector task dialog, click Entities.
Select Contacts from the Entity list.
Select the LIST operation, and then click Done.

Example - Get a deal record

This example gets a record whose ID is 45 from the Deals entity.

In the Configure connector task dialog, click Entities.
Select Deals from the Entity list.
Select the GET operation, and then click Done.
In the Task Input section of the Connectors task, click EntityId and then enter 45 in the Default Value field.
Here, 45 is a primary key value in the Deals entity.

Example - Create a ticket

This example creates a ticket in the Ticket entity.

In the Configure connector task dialog, click Entities.
Select Tickets from the Entity list.
Select the Create operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"Name": "Test735362767",
"Label": "Test735362767",
"Type": "String",
"FieldType": "Insert ticket1",
"GroupName": "ticketinformation",
"Description": "Test ticket"
}
```
If the integration is successful, your connector task's connectorOutputPayload field will have a value similar to the following:
```
{
"Name": "Test1695971640609"
}
```

Example - Update a deals entry

This example updates the record whose ID is 97 in the Contacts entity.

In the Configure connector task dialog, click Entities.
Select Deals from the Entity list.
Select the Update operation, and then click Done.
In the Task Input section of the Connectors task, click connectorInputPayload and then enter a value similar to the following in the Default Value field:
```
{
"Description": "New description"
}
```
Click entityId, and then enter 97 in the Default Value field.
Alternately, instead of specifying the entityId, you can also set the filterClause to 97.

Example - Delete a form

This example deletes the record whose ID is 78 in the Forms entity.

In the Configure connector task dialog, click Entities.
Select Forms from the Entity list.
Select the Delete operation, and then click Done.
In the Task Input section of the Connectors task, click entityId and then enter 78 in the Default Value field.

Use terraform to create connections

You can use the Terraform resource to create a new connection.

To learn how to apply or remove a Terraform configuration, see Basic Terraform commands.

To view a sample terraform template for connection creation, see sample template.

When creating this connection by using Terraform, you must set the following variables in your Terraform configuration file:

Parameter name	Data type	Required	Description
schema	ENUM	True	Specify the HubSpot API version to use. HubSpotV4 is the new API. Supported values are: HubSpot, HubSpotV3, HubSpotV4
browsable_schemas	STRING	False	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
contacts_columns	STRING	False	Comma separated list of properties to select from HubSpot for the Contacts entity.
companies_columns	STRING	False	Comma separated list of properties to select from HubSpot for the Companies entity.
deals_columns	STRING	False	Comma separated list of properties to select from HubSpot for the Deals entity.
proxy_enabled	BOOLEAN	False	Select this checkbox to configure a proxy server for the connection.
proxy_auth_scheme	ENUM	False	The authentication type to use to authenticate to the ProxyServer proxy. Supported values are: BASIC, DIGEST, NONE
proxy_user	STRING	False	A user name to be used to authenticate to the ProxyServer proxy.
proxy_password	SECRET	False	A password to be used to authenticate to the ProxyServer proxy.
proxy_ssltype	ENUM	False	The SSL type to use when connecting to the ProxyServer proxy. Supported values are: AUTO, ALWAYS, NEVER, TUNNEL

Use the HubSpot connection in an integration

After you create the connection, it becomes available in both Apigee Integration and Application Integration. You can use the connection in an integration through the Connectors task.

To understand how to create and use the Connectors task in Apigee Integration, see Connectors task.
To understand how to create and use the Connectors task in Application Integration, see Connectors task.

Get help from the Google Cloud community

You can post your questions and discuss this connector in the Google Cloud community at Cloud Forums.

What's next

Understand how to suspend and resume a connection.
Understand how to monitor connector usage.
Understand how to view connector logs.