Skip to end of banner
Go to start of banner

HubSpot Read

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

In this article

Overview

Use this Snap to retrieve data objects from HubSpot. Learn more about HubSpot APIs from HubSpot Documentation.

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations and Known Issues

None.

Snap Views

FormatTypeNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document

  • Min: 0
  • Max: 1
  • Mapper
  • Copy
  • CSV Parser
A document containing details with which to identify the data object to retrieve from HubSpot.
Output

Document

  • Min: 1
  • Max: 1
  • HubSpot Update
  • CSV Formatter + File Writer
  • Copy

A document containing details of the data object retrieved from HubSpot.

Snap Settings

Field NameField TypeDescription

Label

Default Value: HubSpot Read
Example: 
Read Employee Details

String
Specify a name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Entity


Default Value:
N/A
Example: 
Company

String

Required. Select the data object to read.

Action


Default Value:
N/A
Example: 
Get all companies

String

Required. Select the read-action to perform on the entity selected above. Click  to see the list of supported actions. 

Required parameters



Use this field set to enable the Snap to perform a specific action.

Parameter


Default Value:
N/A
Example: 
company.id

String

Specify the names of the required parameters. Click  to see the list of supported parameters.

Value


Default Value: 
N/A
Example: 
company.id

Multiple

Specify the values of the required parameters. The data type of this field depends on the specified parameter.

Optional parameters

Specify the optional parameters for a specific action. Specify each parameter in a separate row.


Parameter


Default Value:
N/A
Example: 
properties

String

Specify the names of the optional parameters. Click  to see the list of supported parameters.



Value

Default Value: N/A
Example
:name

Multiple

Specify the values for optional parameters. The data type of this field depends on the specified parameter.

Filter parameters




This property enables you to filter the results from the API response based on logical operations. 

Parameter


Default Value:
N/A
Example: 
email

String

Specify the system parameter $filter fields to be included in the output.

Operator


Default Value: 
Like
Example: 
contains

String

Specify the comparison operator for the system parameter $filter.

Value


Default Value:
N/A
Example: @example.com

Multiple

Enter the values of the specified input $filter fields. The data type of this field depends on the specified parameter.

Order records by




Select the order of the specified parameters. The order types to be selected are either ascending or descending.

Not all parameters support sorting. Refer to HubSpot API Documentation for more information.

Parameter


Default Value:
N/A
Example: 
city

String

Enter the parameter for which to specify the order.

Value

Default Value: ASCENDING
Example: 
DESCENDING

String

Select one of the following orders in which to sort the specified parameter:

  • ASCENDING
  • DESCENDING

Advanced options

Use this section of Snap Settings to specify options to control the number of records in the output. This section comprises the following fields:

  • Output entry offset
  • Output entry limit
  • Automatic pagination

Output entry offset


Default Value: 
0
Example: 
1

Integer

Specify the number of records to skip during the read operation. Leave it empty so as not to skip any records.

Output entry limit


Default Value: 
100
Example: 
30

Integer

Select the number of records to fetch in the read operation. Leave it empty to retrieve the default number of records,

Automatic pagination


Default Value: 
Selected

Checkbox

Select this checkbox to enable the Snap to return all the records in the output. By default, the HubSpot Read Snap returns the maximum number of records per page from HubSpot based on the entity. The remaining records, if any, display in the subsequent pages.

If you deselect the Automatic pagination checkbox, the Snap returns only the records of the first page in the output.

Learn more about Usage of Automatic pagination.

Connection timeout


Default Value: 
30
Example
:30

Integer

Required. Enter the connection timeout duration of seconds.

Number of retries


Default Value: 
3
Example:
 3

Integer

Required. Enter the maximum number of re-connection attempts in case of a failure or timeout.

Retry interval (seconds)


Default Value:
N/A
Example: 
3

Integer

Required. Enter the interval in seconds between reconnections attempts.

Retry policy


Default Value: Connection errors
Example: Connection and API limit exceeded errors (429)

Dropdown list

Choose the retry policy for connection and error responses. The available options are:

  • Connection errors: Select this option when the client fails to establish a secure connection to the server.

  • Connection and API limit exceeded errors (429): Select this option when the 10-second or daily limit is exceeded.

Snap Execution


Default Value: 
Validate & Execute
Example:
 Execute only

String

Indicates how the Snap must be executed. Available options are:

  • Validate & Execute: Performs limited execution of the Snap (up to 50 records) during Pipeline validation; performs full execution of the Snap (unlimited records) during Pipeline execution.
  • Execute only: Performs full execution of the Snap during Pipeline execution; does not execute the Snap during Pipeline validation.
  • Disabled: Disables the Snap and, by extension, its downstream Snaps.

Troubleshooting

ErrorReasonResolution

Missing required parameters.

There is a required parameter that was not provided.

Verify whether all required parameters are configured.

Additional Information

Usage of Automatic pagination

The response for auto pagination is an array of response batches where each batch contains the default number of records returned by the HubSpot API for the specific entity. By default, the HubSpot Read Snap returns the maximum number of records per page in the response from HubSpot based on the entity. The remaining records, if any, display in the subsequent pages.

  • If you select the Automatic pagination checkbox, this Snap returns all the records in the output. For example, if there are 100 records for a certain object, and:

    • if the Output entry limit is 5, and the Output entry offset is 0, then the Snap returns 20 batches in the response, with each batch containing 5 records.

    • if the Output entry limit is set as 5. and the Output entry offset is 10, then the Snap returns 18 batches in the response, each batch containing 5 records. The response starts from the 11th record and skips the initial 10 records.

  • If you deselect the Automatic pagination checkbox, the Snap returns only the records of the first page in the output. The Snap decodes the JSON-formatted API response to split all records into single output documents, which are displayed in the output view of the Snap. You can use the Output entry limit and Output entry offset fields. to control the number of records.

General Behavior

The following behaviors of HubSpot are useful to know in order to easily use the read Snap:

  • There are two different date input:

    • Milliseconds.

      • Example: Date 1420772453000. This value represents the date Fri Jan 09 2015 04:00:53 GMT+0100

    • Dates.

      • Example: Date 20150109. This value represents the date Fri Jan 09 2015 00:00:00

  • The maximum of records returned is entity-specific.

  • Some entities of HubSpot have required parameters to be used. Without which, a 404 exception is thrown by HubSpot. This exception indicates the mandatory fields required. 

Example

Retrieving Company Data

We want to retrieve records of the Company entity in HubSpot.  This Pipeline demonstrates how we can use the HubSpot Read Snap to accomplish this task.

We configure the HubSpot Read Snap to read the entity Company with the Get all companies action as shown below:

A successful validation or execution of the Snap gives the following output preview, showing the query results.

We format the above output as a JSON file using the JSON Formatter Snap and write the JSON Formatter Snap's output into a local file using the File Writer Snap. 

To view the newly-created file, we SSH to the target directory and open the newly-created file.

The following picture shows the preview of the result output JSON file.

Download this Pipeline.

Downloads

Important steps to successfully reuse Pipelines

  1. Download and import the Pipeline into SnapLogic.
  2. Configure Snap accounts as applicable.
  3. Provide Pipeline parameters as applicable.

  File Modified
No files shared here yet.



 Click here to expand...

Release

Snap Pack Version 

Date

Type

Updates

November 2024main182 StableUpdated and certified against the current SnapLogic Platform release.

August 2024

main180

 


Stable

Updated and certified against the current SnapLogic Platform release.

May 2024

main172

 


Stable

Enhanced the HubSpot Snaps with the Retry policy field to handle retries for connection and error responses.

February 2024main168 StableUpdated and certified against the current SnapLogic Platform release.
November 2023main166 Latest

Added the following new Bulk Snaps to the HubSpot Snap Pack:

November 2023main160 LatestImproved error reporting in HubSpot Snaps.
November 2023main156 LatestAdded the HubSpot Private App Account to the HubSpot Snap Pack.

November 2023

main155

 

Stable

Updated and certified against the current SnapLogic Platform release.

August 2023

main138

 

Stable

Fixed the pagination issue for the Deals Entity in the HubSpot Read Snap.

May 2023

main130 

Stable

Upgraded with the latest SnapLogic Platform release.

February 2023main114 StableUpgraded with the latest SnapLogic Platform release.
November 2022 main113 StableUpgraded with the latest SnapLogic Platform release.
August 2022main111 StableUpgraded with the latest SnapLogic Platform release.
4.29main108 StableUpgraded with the latest SnapLogic Platform release.
4.28main100 StableUpgraded with the latest SnapLogic Platform release.
4.27main93 StableUpgraded with the latest SnapLogic Platform release.
4.26main88
StableUpgraded with the latest SnapLogic Platform release.
4.25main73
StableNo updates made.
4.24main73
StableNo updates made.

4.23

main73


Latest

Introduced the Snap Pack that serves as a growth platform by integrating an organization's marketing, sales, and customer support services in HubSpot. The HubSpot Snap Pack includes the following Snaps:


See Also

  • No labels