HubSpot Multimode
HubSpot is a cloud-based, AI-driven CRM solution used for tracking details of business relationships. The HubSpot Multimode connector is implemented using HubSpot REST APIs and HubSpot properties, and supports token-based authentication. The HubSpot Multimode connector allows you to perform multiple operations (such as table drops and table inserts) directly on the target database.
• Supported Versions: HubSpot API Version 3.0.
• Querying Data: The HubSpot Multimode connector retrieves data using the HubSpot search API.
• Authentication: HubSpot uses bearer token to do authentication and authorization. When making a call to one of the HubSpot API endpoints, set the value of the Authorization field to Bearer <your_token>, where <your_token> is the bearer token provided by HubSpot.
• Data Operations: The HubSpot Multimode connector allows you to insert, update, and delete data from/to HubSpot. Use HTTP methods (GET, POST, PUT, DELETE) to interact with records.
• Custom Properties and Objects: The HubSpot Multimode connector supports custom properties for HubSpot standard and custom objects.
Note: When creating a new map (manually or using the Map Wizard) and the target has no schema, DataConnect attempts to create one using the source schema. This is a straightforward process with a single record source to a single record target. The process differs with a multi-record (or hierarchical) source to multi-record target. In this case, DataConnect locates the first “flat” source record type (a record where none of the fields are themselves a record) and uses it to generate a basic schema for the target. Users can then build out the schema.
Prerequisites
Before using the connector, perform the following:
• Obtain a HubSpot access token for API calls.
• Obtain access permission for HubSpot objects.
Connector Parts
The HubSpot Multimode connector has a single connector part, an access token, which is granted to users by HubSpot.
Connector parts are the fields you configure to connect with a data source or target. The fields that are available depend on the connector you select.
For a list of all parts for target connectors, see
Specifying Target Connector, Parts, and Properties.
Connector Properties
You can specify the following target (T) properties:
HubSpot Objects
HubSpot objects are divided into standard objects and custom objects. The HubSpot Multimode connector supports the following HubSpot standard objects:
"calls", "cart", "communications", "companies", "contacts",
"deals", "discounts", "emails", "engagements", "fees",
"feedback_submissions","goal_targets", "line_items", "marketing_event","meeting_event",
"notes", "order","postal_mail", "products", "quotes",
"quote_template", "tasks", "taxes", "tickets"
A list of custom objects can be retrieved by API call. Custom objects are listed after the standard objects. Permissions must be set for each object in order to read and write.
For more information about HubSpot objects, refer to HubSpot documentation at
https://developers.hubspot.com/beta-docs/.
Object Properties and Connector Schema
HubSpot object properties are used to store information on CRM records. HubSpot provides a set of default properties for each object. Properties can be used to populate the connector schema for the objects. Custom properties can also be created and managed in HubSpot, or using the properties API.
CRM object properties can be obtained using following REST service call:
HttpGet("https://api.hubapi.com/crm/v3/properties/ " + object_name);
Data Type Support
The following data types are supported:
• bool
• date
• datetime
• string
• numbers
• enumeration
HubSpot APIs
Several HubSpot APIs are provided for the target connector.
Create Objects
To create new objects, make a POST request to /crm/v3/objects/{object_name}.
Do the following in DataConnect:
• Map target fields to the objects: set Target Operation = insert, and Target Object Name = ‘objects’.
• Create associations by mapping all three target association fields: objects, ids, and types. In this case, objects refers to the object name (such as companies and contacts); id refers to the object hs_object_id, and type refers to the association type id.
• Set Target Operation = insert, and Target Object Name = objects/associations.
For more information about HubSpot type id, see https://developers.hubspot.com/docs/api/crm/associations.
Update Objects
To update objects, make a PUT request to /crm/v3/objects/{object_name}/{object_id}.
Do the following in DataConnect:
• Map target fields to the objects.
• Set field ‘hs_object_id’ as the action key.
• Set Target Operation = update, and Target Object Name = ‘objects’.
• Create or remove associations by mapping all three target association fields: objects, ids, and types. In this case, objects refers to the object name (such as companies and contacts); id refers to the object hs_object_id, and type refers to the association type id.
• To insert an association, set id as action key, then set Target Operation = update, and Target Object Name = objects/associations.
• To delete an association, set all three fields as action key, then set Target Operation = delete, and Target Object Name = objects/associations.
For more information about HubSpot type id, see https://developers.hubspot.com/docs/api/crm/associations.
Delete Objects
To delete objects, make a DELETE request to /crm/v3/objects/{object_name}/{object_id}.
Tip... Deleting an object also removes all of its associations. Use Update Objects if you only want to remove a specific object.
Do the following in DataConnect:
• Map target fields to the objects.
• Set field ‘hs_object_id’ as the action key.
• Set Target Operation = delete, and Target Object Name = ‘objects’.