HubSpot
The HubSpot Connector provides automated access to the HubSpot API.
Prerequisites
You will need to create a HubSpot Key in the Key Editor and provide authorization by connecting via OAuth.
Scheduling
The HubSpot connector can be scheduled to ingest data once per day at a user-defined hour and timezone.
By default, the connector will run once at 6am PT.
See Daily Scheduling for more information.
Supported Reports
The Hubspot connector supports a number of reports which you will specify within your SBS Script.
With the exception of emails, these reports support immediate download and do not support backfills.
- hubspot:calls
- Calls logged in CRM records
- See the calls documentation for information on default properties and associations.
- hubspot:deals
- A deal represents an ongoing transaction that a sales team is pursuing with a contact or company
- See the deals overview documentation for information on default properties and associations.
- hubspot:campaigns
- The Hubspot “campaigns” connector type will download all campaigns for the HubSpot account logged.
- hubspot:emails
- Emails Logged in CRM records.
- See the emails documentation for information on default properties and associations.
- hubspot:meetings
- Meetings logged in CRM records.
- See the meetings documentation for information on default properties and associations.
- hubspot:owners
- HubSpot uses owners to assign specific users to contacts, companies, deals, tickets, or engagements.
- See the owners documentation for more information.
- hubspot:email_events
- HubSpot uses emailEvents to get information about events generated by marketing emails or email campaigns sent through a HubSpot account.
- See the Email Events Documentation for more information.
- hubspot:companies
- The companies connector will return a list of all companies for the referenced Hubspot Accounts
- See the Companies Documentation for more information.
- hubspot:deals
- The deals connector will return a list of deals associate with the connected Hubspot account.
- See the Deals Documentation for more information.
Parameters
- associations string list
- optional
- Associations vary per entity/report
- properties string list
- optional
- Properties of an entity vary per entity/report. It is also possible for an entity to have been defined with custom properties.
Sample Switchboard Script
download t from {
key: "hubspot_key";
type: "hubspot:<REPORT-TYPE>";
properties: ["dealname", "hubspot_owner_id", "dealstage"]; // Optional - List of strings
associations: ["companies"]; // Optional - List of strings
} using {c1: integer;};