GetHubSpot

GetHubSpot 2.0.0

Bundle: org.apache.nifi | nifi-hubspot-nar
Description: Retrieves JSON data from a private HubSpot application. This processor is intended to be run on the Primary Node only.
Tags: hubspot
Input Requirement: FORBIDDEN
Supports Sensitive Dynamic Properties: false

Additional Details for GetHubSpot 2.0.0

GetHubSpot

Authentication Methods

The processor is working with HubSpot private applications. A HubSpot private app must be created ( see HubSpot Private App Creation) in order to connect to HubSpot and make requests. Private App Access Tokens are the only authentication method that is currently supported.

Incremental Loading

HubSpot objects can be processed incrementally by NiFi. This means that only objects created or modified after the last run time of the processor are processed. The processor state can be reset in the context menu. The incremental loading is based on the objects last modified time.

Paging

GetHubSpot supports both paging and incrementality at the same time. In case the number of results exceeds the ‘Result Limit’, in the next processor run the remaining objects will be returned.

Due to the page handling mechanism of the HubSpot API, parallel deletions are not supported. Some objects may be omitted if any object is deleted between fetching two pages.

Properties

Access Token
Access Token to authenticate requests

Display Name

Access Token

Description

Access Token to authenticate requests

API Name

access-token

Expression Language Scope

Not Supported

Sensitive

true

Required

true
Incremental Delay
The 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.
Display Name

Incremental Delay

Description

The 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.

API Name

incremental-delay

Default Value

30 sec

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true

Dependencies
- Incremental Loading is set to any of [true]
Incremental Initial Start Time
This 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'
Display Name

Incremental Initial Start Time

Description

This 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'

API Name

incremental-initial-start-time

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false

Dependencies
- Incremental Loading is set to any of [true]
Incremental Loading
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).
Display Name

Incremental Loading

Description

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).

API Name

is-incremental

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Object Type
The HubSpot Object Type requested
Display Name

Object Type

Description

The HubSpot Object Type requested

API Name

object-type

Allowable Values
- Companies
- Contacts
- Deals
- Line Items
- Products
- Tickets
- Quotes
- Calls
- Emails
- Meetings
- Notes
- Tasks
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Result Limit
The maximum number of results to request for each invocation of the Processor

Display Name

Result Limit

Description

The maximum number of results to request for each invocation of the Processor

API Name

result-limit

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

false
Web Client Service Provider
Controller service for HTTP client operations

Display Name

Web Client Service Provider

Description

Controller service for HTTP client operations

API Name

web-client-service-provider

Service Interface

org.apache.nifi.web.client.provider.api.WebClientServiceProvider

Service Implementations

org.apache.nifi.web.client.provider.service.StandardWebClientServiceProvider

Expression Language Scope

Not Supported

Sensitive

false

Required

true

State Management

Scopes	Description
CLUSTER	In 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.

Relationships

Name	Description
success	For FlowFiles created as a result of a successful HTTP request.

Writes Attributes

Name	Description
mime.type	Sets the MIME type to application/json

GetHubSpot 2.0.0

GetHubSpot

Authentication Methods

Incremental Loading

Paging