| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetHubSpot</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetHubSpot</h1><h2>Description: </h2><p>Retrieves JSON data from a private HubSpot application. This processor is intended to be run on the Primary Node only.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>hubspot</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Display Name</th><th>API Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Object Type</strong></td><td>object-type</td><td></td><td id="allowable-values"><ul><li>Companies <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Contacts <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Deals <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Line Items <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Products <img src="../../../../../html/images/iconInfo.png" alt="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." title="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."></img></li><li>Tickets <img src="../../../../../html/images/iconInfo.png" alt="In HubSpot, a ticket represents a customer request for help or support." title="In HubSpot, a ticket represents a customer request for help or support."></img></li><li>Quotes <img src="../../../../../html/images/iconInfo.png" alt="In HubSpot, quotes are used to share pricing information with potential buyers." title="In HubSpot, quotes are used to share pricing information with potential buyers."></img></li><li>Calls <img src="../../../../../html/images/iconInfo.png" alt="Get calls on CRM records and on the calls index page." title="Get calls on CRM records and on the calls index page."></img></li><li>Emails <img src="../../../../../html/images/iconInfo.png" alt="Get emails on CRM records." title="Get emails on CRM records."></img></li><li>Meetings <img src="../../../../../html/images/iconInfo.png" alt="Get meetings on CRM records." title="Get meetings on CRM records."></img></li><li>Notes <img src="../../../../../html/images/iconInfo.png" alt="Get notes on CRM records." title="Get notes on CRM records."></img></li><li>Tasks <img src="../../../../../html/images/iconInfo.png" alt="Get tasks on CRM records." title="Get tasks on CRM records."></img></li></ul></td><td id="description">The HubSpot Object Type requested</td></tr><tr><td id="name"><strong>Access Token</strong></td><td>access-token</td><td></td><td id="allowable-values"></td><td id="description">Access Token to authenticate requests<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Result Limit</td><td>result-limit</td><td></td><td id="allowable-values"></td><td id="description">The maximum number of results to request for each invocation of the Processor<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Incremental Loading</strong></td><td>is-incremental</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="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).</td></tr><tr><td id="name"><strong>Incremental Delay</strong></td><td>incremental-delay</td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="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.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Incremental Loading] Property has a value of "true".</strong></td></tr><tr><td id="name">Incremental Initial Start Time</td><td>incremental-initial-start-time</td><td></td><td id="allowable-values"></td><td id="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'<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong><br/><br/><strong>This Property is only considered if </strong><strong>the [Incremental Loading] Property has a value of "true".</strong></td></tr><tr><td id="name"><strong>Web Client Service Provider</strong></td><td>web-client-service-provider</td><td></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>WebClientServiceProvider<br/><strong>Implementation: </strong><a href="../../../nifi-web-client-provider-service-nar/1.19.1/org.apache.nifi.web.client.provider.service.StandardWebClientServiceProvider/index.html">StandardWebClientServiceProvider</a></td><td id="description">Controller service for HTTP client operations</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>For FlowFiles created as a result of a successful HTTP request.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets the MIME type to application/json</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>CLUSTER</td><td>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.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> |