How to use the HubSpot connection

This feature is accessible by adding a new connection, a source step, a lookup step or a destination step that connects to HubSpot.

The below page is where you will create a connection by logging into HubSpot to retrieve your authorization access token. Click on the highlighted down arrow on the right of the Connection Type field to choose the required connection. There are 3 connections types available which are; oAuth where you use the access token, Private App if you’re using custom scopes and Api Key if you’re logging in HubSpot with an API Key. This page is accessible by creating a connection in the solution or by creating a connection in the source, lookup or destination step.

NB: If you are using custom objects/ scopes in your API, please ensure that you have an Enterprise account and create your Private HubSpot App before you use the Synatic HubSpot connector.

We have 2 HubSpot source steps available. Illustrated in the image below is the HubSpot source step for basic API function calls. You can also create a new connection by clicking on the highlighted icon. In the Resource field, you populate the resource that you want to query. In the Fields section, you can add specific fields that you want to call or you can leave it blank to call all fields from the resource. You can limit the number of records you want to return from the query by typing a number in the Limit field.

NB: For paging, click on Advanced Mode (location on the top right of the page) and the Page Size field and Page Delay field will appear.

Illustrated in the image below is the HubSpot Service source step for open-ended API function calls. Create a connection or select an existing connection from the drop down list. You can populate the Route field with the API route, excluding the base path. You can enable paging by clicking in the Paged check box if required. You can include offset by clicking in the Include Offset check box if required. You can limit the number of records you want to return in the Limit field.

NB: For paging, click on Advanced Mode (location on the top right of the page) and the Page Size field will appear.

The below link is information containing the API references:

HubSpot APIs | Getting started

The HubSpot Lookup step is similar to the HubSpot source step as shown in the below image. You populate the Resource field and add fields if required. In the Mappings section, you can add the fields that you want to map from the resource you are looking up to the current fields in your data set. If a field is not found in the resource, you can select what you want it to return by clicking on the drop down list in the On Not Found field. Click on Advanced Mode if you want to enable caching, do concurrent calls or pass errors and the fields will appear.

We have 3 HubSpot destination steps available. In the image below is the HubSpot Contacts Bulk destination step where you can send bulk data directly to the Contacts resource in HubSpot. You can create or select a connection to HubSpot. Click on Advanced Mode if you want to send the bulk data in batches and the batch fields will appear.

The below link contains information on the Contacts API:

https://developers.hubspot.com/docs/api/crm/contacts

Illustrated in the below image is the HubSpot destination step to send data using basic API functions. You can create a connection or select an existing connection. In the Resource field, you populate the resource that you want to create or update.

Illustrated in the image below is the HubSpot Service destination step to send data using open-ended API functions such as creating an engagement. You can create a connection or select an existing connection. In the Route field, you populate the API route, excluding the base path. You can select the type of HTTP method you require in the HTTP Method drop down list. Click in the Ignore Body check box if you don’t want to send the body as part of the request.

The below link is the API references that can be used to create an engagement:

Create an Engagement | Engagements API