HubSpot

The HubSpot integration utilizes DataGrail's HubSpot OAuth 2.0 App and this documentation describes the technical capabilities of this integration, including authorization, scopes/permissions, and utilized endpoints. For more information on how to integrate HubSpot, visit our connection instructions.

Version

This integration utilizes the HubSpot API v3.

Base URL

The base URL used for all HubSpot API endpoints:

https://api.hubapi.com

---

Authentication & Authorization

The DataGrail HubSpot integration connects using OAuth 2.0.

Scopes

The HubSpot integration requires specific scopes that must be granted in order to function for a given capability.

Scope	Base	Access	Deletion	Data Discovery	System Detection
oauth	✅
content		✳️	✳️	✳️
crm.lists.read		✅	✅
crm.objects.contacts.read	✅
crm.objects.contacts.write			✅
crm.objects.custom.read				✳️
crm.objects.deals.read		✅	✅
crm.schemas.contacts.read					✅
crm.schemas.companies.read					✳️
e-commerce					✳️
sales-email-read		✳️	✳️	✳️
tickets					✳️

✳️ optional scope

Base Scopes

All base scopes must be granted in order to connect the integration with DataGrail. The remaining scopes are only required if enabling those capabilities

Endpoints Utilized

DataGrail uses the following endpoints to authorize and test the connection:

Method	Endpoint	Purpose	Docs
GET	/integrations/v1/me	Verify authentication
GET	/oauth/authorize	Request authorization
GET	/oauth/v1/access-tokens/TOKEN	Verify scopes
GET	/oauth/v1/token	Get and refresh access token

---

Limits

Limits in HubSpot are calculated using the leaky bucket algorithm. All requests that are made after rate limits have been exceeded are throttled and an HTTP 429 Too Many Requests error is returned. Requests succeed again after enough requests have emptied out of the bucket.

• DataGrail supports requests throttling to stay within 70-80% of specified service rate limits.
• DataGrail processes API responses with HTTP 429 status to interrupt requests, waiting and retrying (using an exponential backoff strategy).

---

Capabilities

Access

DataGrail's HubSpot integration provides Synchronous Access capabilities for the following supported identifier category: Email.

Data Interactions

For Access requests, DataGrail will take the following actions:

1. Search for Contacts using the Data Subject email address.
2. If a match is found, DataGrail will extract all objects related to the contact, including the following:

Match Found

• Calls
• Emails
• Meetings

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/crm/v3/objects/contacts/CONTACT_ID/associations/calls	Get calls associated with a contact
GET	/crm/v3/objects/contacts/CONTACT_ID/associations/emails	Get emails associated with a contact
GET	/crm/v3/objects/contacts/CONTACT_ID/associations/meetings	Get meetings associated with a contact
POST	/crm/v3/objects/contacts/search	Fetch contacts by email

---

Deletion

DataGrail's HubSpot integration provides Synchronous Deletion capabilities for the following supported identifier category: Email.

Data Interactions

For Deletion requests, DataGrail will take the following actions:

1. Extract data subject information using the Access Flow.
2. If a match is found, DataGrail will delete the contact and associated records (if selected).

Endpoints Utilized

Method	Endpoint	Purpose	Docs
POST	/crm/v3/objects/contacts/gdpr-delete	Delete contact and associated records

Anonymization

By request, HubSpot deletion can be switched to anonymization mode.

In this mode, for a deletion request, DataGrail will not delete any objects, but update them, using pre-configured customer's anonymization rules.

---

System Detection

DataGrail provides continuous system detection, delivering a real-time inventory of your data assets.

Data Interactions

DataGrail's System Detection process runs once daily and reads object properties and recently-updated contacts to detect new systems added in HubSpot:

1. Fetch properties for the following objects:
   • Contacts
   • Tickets
   • Products
   • Line Items
   • Companies
2. Extract recently created/updated contacts.
3. Get contact details by visitor ID for each contact identified in step 2.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/contacts/v1/contact/vid/VID/profile	Get contact details by visitor ID
GET	/contacts/v1/lists/recently_updated/contacts/recent	Get details on recent contacts
GET	/properties/v1/companies/properties	Get company properties
GET	/properties/v1/contacts/properties	Get contact properties
GET	/properties/v2/line_items/properties	Get line item properties
GET	/properties/v2/products/properties	Get product properties
GET	/properties/v2/tickets/properties	Get ticket properties

---

Data Discovery

DataGrail's HubSpot integration provides data discovery capabilities based on the principle of finding any and all personal data that's stored in a data system.

Data Interactions

DataGrail will take the following actions for HubSpot Data Discovery:

1. Count number of all records for each of supported objects.
2. Fetch example records for each of the supported objects.

Supported Objects

• contacts
• emails
• deals
• notes
• tasks
• calls
• meetings
• communications
• postal_mail
• custom objects detected through retrieving the standard objects above.

3. Sample data for the next analysis and classification.

Endpoints Utilized

Method	Endpoint	Purpose	Docs
GET	/crm/v3/objects/OBJECT_NAME	Get details from a supported object
POST	/crm/v3/objects/OBJECT_NAME/search	Fetch an example of a supported object
GET	/crm/v3/schemas	Get all schemas
GET	/properties/v2/OBJECT_NAME/properties	Get details from a supported object