HubSpot Bulk Read
In this article
Overview
You can use this Snap to retrieve data objects in bulk from HubSpot. Learn more: HubSpot APIs.
Snap Type
The HubSpot Bulk Read Snap is a Read-type Snap.
Prerequisites
None.
Support for Ultra Pipelines
Works in Ultra Pipelines.Â
Known Issues and Limitations
None.
Snap Views
Type | Format | Number of Views | Examples of Upstream and Downstream Snaps | Description |
---|---|---|---|---|
Input | Document |
|
| A document containing details with which to identify the data object(s) to retrieve from HubSpot. |
Output | Document  |
|
| A document that contains details of the data object(s) retrieved from HubSpot. |
Error | Error handling is a generic way to handle errors without losing data or failing the Snap execution. You can handle the errors that the Snap might encounter when running the pipeline by choosing one of the following options from the When errors occur list under the Views tab:
Learn more about Error handling in Pipelines. |
Snap Settings
Asterisk (*): Indicates a mandatory field.
Suggestion icon (): Indicates a list that is dynamically populated based on the configuration.
Expression icon ( ): Indicates the value is an expression (if enabled) or a static value (if disabled). Learn more about Using Expressions in SnapLogic.
Add icon ( ): Indicates that you can add fields in the fieldset.
Remove icon (): Indicates that you can remove fields from the fieldset.
Upload icon ( ): Indicates that you can upload files.
Field Name | Field Type | Description | |
---|---|---|---|
Label* Default value: HubSpot Bulk Read Example: Bulk Read Company Details  | String | Specify a name for the Snap. If you have more than one of the same snaps in the pipeline, you can modify this and create a unique name. | |
API Version* Â Default Value:Â V3 | Dropdown list | Select the version of the API to use for the pipeline. | |
Category* Default Value: N/A | String/Suggestion | Select the application from which to retrieve the data objects. | |
Entity*
| String/Suggestion | Select the data object to read. Alternatively, click the Suggestion icon to select the entity. | |
Action*
| String/Suggestion | Select the read-action to perform on the selected entity. Alternatively, click the Suggestion icon to select the supported action. | |
Required Parameters | Use this field set to enable the Snap to perform a specific action. | ||
Parameter Default Value: N/A | String/Suggestion | Specify the names of the required parameters. Alternatively, click the Suggestion icon to select the required parameter. | |
Value Default Value: N/A | String | Specify the values for the required parameters. The data type of this field depends on the specified parameter. | |
Optional Parameters | Specify the optional parameters for a specific action. | ||
Parameter Default Value: N/A | String/Suggestion | Specify the names of the optional parameters. Alternatively, click the Suggestion icon to select the parameter. | |
Value Default Value: N/A | String | Specify the values for optional parameters. The data type of this field depends on the specified parameter. | |
Connection timeout* Default Value: 30 | Integer | Specify the time in seconds for the Snap to wait before terminating the request because of a failure to estabish a connection to the target service. | |
Number of retries* Default Value: 0 | Integer | Specify the maximum number of retry attempts to make if a connection failure or timeout occurs. | |
Retry interval (seconds)* Default Value: 0 | Integer | Specify the number of seconds for which the Snap must wait before attempting recovery from a network failure. | |
Retry policy  Default Value: Connection errors | Dropdown list | Choose the retry policy for connection and error responses. The available options are:
| |
Snap Execution Default Value:Â Execute only | Dropdown list | Select one of the following three modes in which the Snap executes:
|
Troubleshooting
Error | Reason | Resolution |
---|---|---|
Examples
Retrieve details of a batch of companies
The following example pipeline demonstrates how to retrieve the details of a batch of companies from HubSpot.
Configure the JSON generator Snap to provide the company name as an input to retrieve the specific company details. On validation, the JSON output is displayed in the output preview.
Configure the Mapper Snap to map the output details from the JSON Generator Snap to the corresponding fields in HubSpot.
On validation of the Snap, the JSON input fields are mapped to the HubSpot entity's fields as shown below:
Finally, the output from the Mapper Snap is passed on to the HubSpot Bulk Read Snap.
Configure the HubSpot Bulk Read Snap with the Company Entity and Read a Batch of Companies action.
Â
On validating the HubSpot Bulk Read Snap, the Snap retrieves the details of a batch of companies as shown below:
Downloads
Download and import the Pipeline into SnapLogic® Platform .
Configure Snap accounts, as applicable.
Provide Pipeline parameters, as applicable.
Snap Pack History
Related Content
Â
Have feedback? Email documentation@snaplogic.com | Ask a question in the SnapLogic Community
© 2017-2024 SnapLogic, Inc.