Hubspot

📘

Check out the docs Hubspot API (hubspot.com) for more information

Set up

Accessing the Hubspot APIs

• In order to access the Hubspot API's you will first need to create a Private App within your Hubspot account.

To create a private app follow the below steps:

• In your HubSpot account, click the settings icon in the main navigation bar.
• In the left sidebar menu, navigate to Integrations > Private Apps.
• Click Create private app.
• On the Basic Info tab, configure the details of your app:
• Enter your app's name.
• Hover over the placeholder logo and click the upload icon to upload a square image that will serve as the logo for your app.
• Enter a description for your app.
• Click the Scopes tab.
• Select the Read or Write checkbox for each scope you want your private app to be able to access. You can also search for a specific scope using the Find a scope search bar.

Below are the scopes you will definitely need to make requests to the available Kleene extracts:

• Business-Intelligence
• Integration-sync
• Content
• Social
• crm.objects.marketing_events.read (requires Enterprise level access)
• crm.objects.companies.read
• crm.objects.deals.read
• crm.objects.contacts.read
• crm.objects.owners.read
• sales-email-read (to read engagement emails)

After you're done configuring your app, click Create app in the top right.
Once the Private app has been set-up you will be able to see the API access token upon request. You will use this token to set-up the source in the Kleene app.

Set up Source in the Kleene app

Now you should have everything you need to set up the source in the Kleene app.

• Source name
  Choose any name you wish

• Description
  Give the source a meaningful description.

• Hubspot API Key
  This is the API key associated with the private app created for the Kleene integration.

Features

Reports detail

The Custom Objects Endpoint response contains a large amount of data, particularly in the ‘properties’ and ‘associations’ fields.

To organise this data, the response is split into three separate reports:

1. Custom Objects Metadata: Contains the original response.
2. Custom Objects Associations: Unwinds the 'associations' field for a clearer representation.
3. Custom Objects Properties: Unwinds the 'properties' field for better clarity and detail.

To retrieve Custom Object data there are two methods:

Option 1:

The 'All Custom Objects Data' report retrieves information from every custom object in the account, all in one extract. However, this process can be time-intensive due to the potentially large volume of data, so Option 2 is generally preferred for faster results.

Option 2:

1. Run the Custom Objects Metadata report to get a list of all Custom Object names. This report provides a column with the fullyQualifiedNames, which are the names of the Custom Objects.
2. Take a fullyQualifiedName from the list and enter it into the Custom Object Field in the Custom Objects Field Selection report. This will return the data for the selected Custom Object field/name.

📘

Workflows performance statistics

This report uses DAYsetting for the Time period.

🚧

Deprecated reports on connector version

0.0.9

The old association reports (e.g., Contacts Associations, Companies Associations) were deprecated and replaced with updated versions. The new reports are marked with *"NEW VERSION" in their names.

0.0.10

The Deals Associations report was also deprecated and replaced with a new version (also marked with "*NEW VERSION").

0.0.11

• Line Items Association – *New Approach
• Properties – *New Approach (for user-defined objects, replacing the old report with limited object support, and now also supporting custom objects)

0.0.13

• Deal Associations report replaces ( Deal Associations (without engagements) and Deal Associations (without engagements)).
• Contact Associations *DEPRECATED report was removed.
• Company Associations *DEPRECATED report was removed.
• Contact Associations *NEW APPROACH report renamed to Contact Associations.
• Line Items Association *NEW APPROACH report renamed Line Items Associations.
• Custom Objects Properties *DEPRECATED report renamed to Custom Objects Properties.
• Custom Objects Associations *DEPRECATED report renamed to Custom Objects Associations.
• Properties *NEW APPROACH report renamed to Properties (Custom Object).

Note: Older (*DEPRECATED) reports may have missed associations if the number exceeded 100.