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
| Format | Type | Number of Views | Examples of Upstream and Downstream Snaps | Description |
|---|---|---|---|---|
| Input | Document |
|
| A document containing details with which to identify the data object to retrieve from HubSpot. |
| Output | Document |
|
| A document containing details of the data object retrieved from HubSpot. |
Snap Settings
| Field Name | Field Type | Description | |
|---|---|---|---|
Label Default Value: HubSpot Read | 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
| String | Required. Select the data object to read. | |
Action
| String | Required. Select the read-action to perform on the entity selected above. Click | |
Required parameters | Use this field set to enable the Snap to perform a specific action. | ||
Parameter
| String | Specify the names of the required parameters. Click | |
Value
| 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
| String | Specify the names of the optional parameters. Click | |
Value Default Value: N/A | 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
| String | Specify the system parameter $filter fields to be included in the output. | |
Operator
| String | Specify the comparison operator for the system parameter $filter. | |
Value
| 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
| String | Enter the parameter for which to specify the order. | |
Value Default Value: ASCENDING | String | Select one of the following orders in which to sort the specified parameter:
| |
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
| 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
| Integer | Select the number of records to fetch in the read operation. Leave it empty to retrieve the default number of records, | |
Automatic pagination
| 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
| Integer | Required. Enter the connection timeout duration of seconds. | |
Number of retries
| Integer | Required. Enter the maximum number of re-connection attempts in case of a failure or timeout. | |
Retry interval (seconds)
| Integer | Required. Enter the interval in seconds between reconnections attempts. | |
Snap Execution
| String | Indicates how the Snap must be executed. Available options are:
| |
Troubleshooting
| Error | Reason | Resolution |
|---|---|---|
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.
Downloads
Important steps to successfully reuse Pipelines
- Download and import the Pipeline into SnapLogic.
- Configure Snap accounts as applicable.
- Provide Pipeline parameters as applicable.