Hubspot
Version 0.0.9
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
Feature | Support | Notes |
---|---|---|
Backfill | ✅ | All-time |
Incremental | ❌ | |
API reliability | 🟢 | Reliable |
Reports detail
⬇️ Report | 🔑 Primary key | 📄 Link to API endpoint |
---|---|---|
Deals | ID | Deals Report |
Deal Associations (without engagements) | ID | Deals Report |
Deal Associations (engagements only) | DEAL_ID | Associations |
Feedback Submissions | ID | Feedback Submissions |
Feedback Submissions Associations (contacts) | FEEDBACK_SUBMISSION_ID | Associations |
Owners | ID | Owners Report |
Pipelines | ID | Pipelines Report |
Properties | ID | Properties Report |
Calls | ID | Calls Report |
Line Items | ID | Line Items Report |
Emails | ID | Emails Report |
Communications | ID | Communications Report |
Postal Mail | ID | Postal Mail Report |
Meetings | ID | Meetings Report |
Tasks | ID | Tasks Report |
Notes | ID | Notes Report |
Contacts | ID | Contacts Report |
Contact Associations | ID | Contact Associations Report |
Companies | ID | Companies Report |
Company Associations | ID | Company Associations Report |
Tickets | ID | Tickets Report |
Ticket Associations | ID | Ticket Associations Report |
Email Campaigns | ID | Email Campaigns Report |
Marketing Emails | ID | Marketing Emails Report |
Marketing Events | ID | Marketing Events Report |
All Custom Objects Data | ID | CRM Custom Objects |
Custom Objects Metadata | ID | CRM Custom Objects |
Custom Objects Associations | ID | CRM Custom Objects |
Custom Objects Properties | ID | CRM Custom Objects |
Custom Objects Field Selection | ID | CRM Custom Objects |
Workflows | ID | Workflows |
Workflows performance statistics | ID | Performance Statistics |
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:
- Custom Objects Metadata: Contains the original response.
- Custom Objects Associations: Unwinds the 'associations' field for a clearer representation.
- 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:
- Run the Custom Objects Metadata report to get a list of all Custom Object names. This report provides a column with the
fullyQualifiedName
s, which are the names of the Custom Objects. - 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
DAY
setting for the Time period.
"Associations" deprecated reports on connector version 0.0.9
Old association reports (e.g. Contacts Associations, Companies Associations) have been deprecated on version 0.0.9 of the connector and replaced with new versions (report names will include * NEW VERSION for those).
Older reports may have had missing associations when these exceeded 100.
Updated about 2 months ago