GetHubSpot

Description:

Retrieves JSON data from a private HubSpot application. This processor is intended to be run on the Primary Node only.

Additional Details...

Tags:

hubspot

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Object Typeobject-type
  • Companies In HubSpot, the companies object is a standard CRM object. Individual company records can be used to store information about businesses and organizations within company properties.
  • Contacts In HubSpot, contacts store information about individuals. From marketing automation to smart content, the lead-specific data found in contact records helps users leverage much of HubSpot's functionality.
  • Deals In HubSpot, a deal represents an ongoing transaction that a sales team is pursuing with a contact or company. It’s tracked through pipeline stages until won or lost.
  • Line Items In HubSpot, line items can be thought of as a subset of products. When a product is attached to a deal, it becomes a line item. Line items can be created that are unique to an individual quote, but they will not be added to the product library.
  • Products In HubSpot, products represent the goods or services to be sold. Building a product library allows the user to quickly add products to deals, generate quotes, and report on product performance.
  • Tickets In HubSpot, a ticket represents a customer request for help or support.
  • Quotes In HubSpot, quotes are used to share pricing information with potential buyers.
  • Calls Get calls on CRM records and on the calls index page.
  • Emails Get emails on CRM records.
  • Meetings Get meetings on CRM records.
  • Notes Get notes on CRM records.
  • Tasks Get tasks on CRM records.
The HubSpot Object Type requested
Access Tokenaccess-tokenAccess Token to authenticate requests
Sensitive Property: true
Result Limitresult-limitThe maximum number of results to request for each invocation of the Processor
Supports Expression Language: true (will be evaluated using Environment variables only)
Incremental Loadingis-incrementaltrue
  • true
  • false
The processor can incrementally load the queried objects so that each object is queried exactly once. For each query, the processor queries objects within a time window where the objects were modified between the previous run time and the current time (optionally adjusted by the Incremental Delay property).
Incremental Delayincremental-delay30 secThe ending timestamp of the time window will be adjusted earlier by the amount configured in this property. For example, with a property value of 10 seconds, an ending timestamp of 12:30:45 would be changed to 12:30:35. Set this property to avoid missing objects when the clock of your local machines and HubSpot servers' clock are not in sync and to protect against HubSpot's mechanism that changes last updated timestamps after object creation.
Supports Expression Language: true (will be evaluated using Environment variables only)

This Property is only considered if the [Incremental Loading] Property has a value of "true".
Incremental Initial Start Timeincremental-initial-start-timeThis property specifies the start time that the processor applies when running the first request. The expected format is a UTC date-time such as '2011-12-03T10:15:30Z'
Supports Expression Language: true (will be evaluated using Environment variables only)

This Property is only considered if the [Incremental Loading] Property has a value of "true".
Web Client Service Providerweb-client-service-providerController Service API:
WebClientServiceProvider
Implementation: StandardWebClientServiceProvider		Controller service for HTTP client operations

Relationships:

NameDescription
successFor FlowFiles created as a result of a successful HTTP request.

Reads Attributes:

None specified.

Writes Attributes:

NameDescription
mime.typeSets the MIME type to application/json

State management:

ScopeDescription
CLUSTERIn case of incremental loading, the start and end timestamps of the last query time window are stored in the state. When the 'Result Limit' property is set, the paging cursor is saved after executing a request. Only the objects after the paging cursor will be retrieved. The maximum number of retrieved objects can be set in the 'Result Limit' property.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.