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 | 🔑 Incremental key | 🔑 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 | |
Custom Objects Full | ID | CRM Custom Objects | |
Custom Objects Associations | ID | CRM Custom Objects | |
Custom Objects Properties | ID | CRM Custom Objects | |
Workflows | ID | Workflows | |
Workflows performance statistics | ID | Performance Statistics |
From the Custom Objects Endpoint response, the fields ‘properties’ and ‘associations’ give a lot of data.
As a result, the response to be split into 3 separate reports: “Custom Objects Full“, “Custom Objects Associations“, “Custom Objects Properties“. The first has the original response and the latter 2 have the mentioned fields unwinded to give a better representation of the data.
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 1 day ago