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.

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
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.

Optional Parameters

Specify the optional parameters for a specific action.

Parameter

Default Value: N/A
Example: properties

String/Suggestion

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

Value

Default Value: N/A
Example: name

String

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

Connection timeout*

Default Value: 30
Example: 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
Example: 4

Integer

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

Retry interval (seconds)*

Default Value: 0
Example: 10

Integer

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

Snap Execution

Default Value: Execute only
Example: Validate & Execute

Dropdown list

Select one of the following three modes in which the Snap executes:

• 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.