HubSpot Bulk Read

In this article

Overview

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

Overview (5).png

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

Type

Format

Number of Views

Examples of Upstream and Downstream Snaps

Description

Input 

Document

  • Min: 0

  • Max: 1

  • Mapper Snap

  • Copy Snap

  • CSV Snap

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

Output

Document

 

  • Min: 1

  • Max: 1

  • HubSpot Update

  • CSV Formatter + File Writer

  • Copy

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:

  • Stop Pipeline Execution: Stops the current Pipeline execution if the Snap encounters an error.

  • Discard Error Data and Continue: Ignores the error, discards that record, and continues with the remaining records.

  • Route Error Data to Error View: Routes the error data to an error view without stopping the Snap execution.

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

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 ValueV3
Example: V4

Dropdown list

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

Category*

Default Value: N/A
Example: CRM

String/Suggestion

Select the application from which to retrieve the data objects.

Entity*


Default Value: N/A
Example: Companies

String/Suggestion

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

Action*


Default Value: N/A
Example: Read a batch of Companies

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
Example: company.id

String/Suggestion

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

Value

Default Value: N/A
Example: company.id

String

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