HubSpot Bulk Read

Overview

You can use this Snap to retrieve data objects in bulk from HubSpot. Learn more: HubSpot APIs.hubspot-bulk-read-overview

Supported Accounts

Examples

Prerequisites

A valid HubSpot Account with the required permissions.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

A document containing details with which to identify the data object(s) to retrieve from HubSpot.

Output

A document that contains details of the data object(s) retrieved from HubSpot.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String

Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: HubSpot Bulk Read

Example: Bulk Read Company Data
API Version*

Dropdown list

Select the version of the API to use for the pipeline.

Default value: V3

Example: V4
Category*

String

Select the application from which to retrieve the data objects.

Default value: N/A

Example: CRM
Entity*

String

Select the data object to read. Alternatively, click the Suggestion icon to select the entity.

Default value: N/A

Example: Companies
Action*

String

Select the read-action to perform on the selected entity. Alternatively, click the Suggestion icon to select the supported action.

Default value: N/A

Example: Read a batch of Companies
Parameter

Specify the names of the required parameters. Alternatively, click the Suggestion icon to select the required parameter.
Value*

String

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

Default value: N/A

Example: company.id
Parameter

Specify the names of the optional parameters. Alternatively, click the Suggestion icon to select the parameter.
Value

String

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

Default value: N/A

Example: name
Connection timeout*

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.

Default value: 30

Example: 30
Number of retries*

Integer

Specify the maximum number of retry attempts to make if a connection failure or timeout occurs.

Default value: 0

Example: 4
Retry interval (seconds)*

Integer

Specify the number of seconds for which the Snap must wait before attempting recovery from a network failure.

Default value: 0

Example: 10
Retry policy

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.

Default value: Connection errors

Example: Connection and API limit exceeded errors (429)
Snap execution

Dropdown list
Choose one of the three modes in which the Snap executes. Available options are:
  • Validate & Execute. Performs limited execution of the Snap and generates a data preview during pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during pipeline runtime.
  • Execute only. Performs full execution of the Snap during pipeline execution without generating preview data.
  • Disabled. Disables the Snap and all Snaps that are downstream from it.

Troubleshooting

Error Reason Resolution
Missing required parameters. There is a required parameter that was not provided. Verify whether all required parameters are configured.
You have reached your ten-second rolling limit. There are too many requests to REST endpoint. Select Connection and API limit exceeded errors (429) in the Retry policy field and adjust the values for Number of retries and Retry interval.
You have reached your daily limit. There are too many requests to REST endpoint. The maximum number of daily requests has been reached, and no further requests can be made until it resets. For more information, refer to HubSpot Documentation.