Skip to main content

Striim Platform 5.0 documentation

HubSpot Reader programmer's reference

HubSpot Reader properties

Property

Type

Default value

Notes

Auth Mode

Select list

  • OAuth

  • Private app token

Client ID

String

Required for authentication with OAuth

Client secret

Password

Required for authentication with OAuth

Connection pool size

Integer

20

Specifies the number of connections in use.

Connection profile name

String

Used when the Use connection profile property is set to True .

Select the name of the HubSpot Reader connection from the list.

Exclude tables

String

A list of tables excluded from read operations. Typically used to create a list of exceptions when the Tables property includes wildcards. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors.

Incremental load marker

String

Value of the Last_Modified_Date field.

The incremental load marker is a unique incremental column in each object used for incremental load. When no marker is specified, tables are resynced at each polling interval.

Migrate schema

Boolean

False

Only available in Initial Load or Automated mode. Set to True to enable initial schema migration, which propagates the object schema from the source to the target..

Mode

Select list

  • Automated mode

  • Initial load

  • Incremental load

Automated mode applies incremental updates to objects that support incremental load and performs full resyncs for objects that do not support incremental load.

Polling interval

String

5m

Specifies an interval as an integer followed by a unit. Supported units are days (d), hours (h), minutes (m), or seconds (s). The Striim HubSpot reader polls the HubSpot instance at the specified interval.

Private app token

Password

Required for authentication with Private app token

Refresh token

Password

Required for authentication with OAuth

Start position

String

%=-1

Value of the incremental load marker that defines the initial reading position.

Use connection profile

Boolean

Set to True to use a connection profile instead of specifying the connection properties here. See Introducing connection profiles.

Tables

String

A semicolon-delimited (;) list of objects to read from the HubSpot instance. Supports the % wildcard. Misconfiguration of the Tables and Exclude Tables properties can cause "Invalid table names" errors. Do not modify this property when recovery is enabled for the application.

Thread pool counter

Integer

10

The number of parallel running threads. The default value of zero specifies single-threaded operation.

When the value of the thread pool counter is higher than the connection pool size, large data ingestion operations can cause the app to halt. Since best performance is achieved when using one thread for each table being synced, increasing the size of the connection pool to match the number of threads in use is a performance best practice.

Supported objects

The HubSpot Reader supports the following HubSpot objects. Each object lists the scopes an account must have in order to access that object.

Table

Scopes

Companies

crm.objects.companies.read

crm.schemas.companies.read

Contacts

crm.object.contacts.read

crm.schemas.contacts.read

Deals

crm.objects.deals.read

crm.schemas.deals.read

DealPipelines

crm.objects.deals.read

crm.schemas.deals.read

DealPipelineStages

crm.objects.deals.read

crm.schemas.deals.read

FeedbackSubmissions

crm.objects.feedback_submissions.read

Note

Requires an Enterprise account.

Forms

forms

forms-uploaded-files

LineItems

crm.objects.line_items.read

crm.schemas.line_items.read

Products

e-commerce

Note

This scope requires a HubSpot Professional or Enterprise account.

Quotes

crm.objects.quotes.read

crm.schemas.quotes.read

Tickets

tickets

TicketPipelines

tickets

TicketPipelineStages

tickets

EngagementsCalls

crm.objects.contacts.read

EngagementsEmails

crm.objects.contacts.read

sales-email-read

EngagementsMeetings

crm.objects.contacts.read

EngagementsNotes

crm.objects.contacts.read

EngagementsTasks

crm.objects.contacts.read

Owners

crm.objects.owners.read

Goals

crm.objects.goals.read

Note

This scope requires a HubSpot Sales Hub Starter, Professional, or Enterprise account.

CustomObjects

crm.objects.custom.read

Note

This scope requires a HubSpot Enterprise account.

crm.schemas.custom.read

The Hubspot Reader also supports the following association objects.

  • CompanyAssociations

  • ContactAssociations

  • CustomObjectAssociations

  • DealAssociations

  • FeedbackSubmissionAssociations

  • LineItemAssociations

  • QuoteAssociations

  • TicketAssociations

  • CallAssociations

  • EmailAssociations

  • MeetingAssociations

  • NoteAssociations

  • TasksAssociations

In this section: